乐趣区

编程–代码规范

代码规范 1. 作用
1). 提高可读性
2). 统领全局, 促进团队协助
3). 有助于知识传递, 加快工作交接
4). 减少名字增生, 降低维护成本
5). 强调变量之间关系, 降低缺陷引入的机会
6). 提高程序员个人能力
2. 规范
1). 命名空间
2). 代码风格
A). 花括号不允许省略
B). 不允许省略访问修饰符
C). 类型默认是密封的
D). 不允许公开字段
E). 使用括号强调运算优先级
3). 命名规范 (Pascal( 大驼峰)、Camel(小驼峰))
A). 类、结构和接口命名
a). 使用名词或名词短语
b). 使用 Pascal 方式 (增加识别和可读性)
c). 在接口名称前加上前缀 I
d). 考虑在派生类末尾使用基类的名称
e). 如果该类仅仅为了实现某个接口, 保持其与接口命名的统一
B). 成员命名
a). 方法 (Pascal 公开、Camel 私有) 用动词或动词短语命名
b). 属性 (Pascal) 用名词、名词短语或形容词来命名 (复数 / 布尔)
c). 事件 (Pascal) 用动词或动词短语来命名事件 (现在时 / 过去时)
d). 字段 (Camel 私有) 用名词、名词短语或形容词来命名
C). 参数命名
a).Camel 风格
b). 要使用 left 和 right 来命名重载的二元操作符的参数 如果参数没有具体的含义
c). 要使用 value 来命名重载的一元操作符的参数 如果参数没有具体的含义
d). 不要在参数中使用数字编号
e). 尽量使用描述性的名字命名泛类型参数, 并在前面使用 T 前缀
D). 常量、变量命名
a). 常量 所有单词大写用下划线分隔
b). 局部变量 Camel 风格
E). 枚举命名
a).Pascal 风格
b). 使用名词的复述形势来命名标记枚举
c). 不要添加 ENUM 或 Flag 后缀
d). 不要给枚举类型值的名称加前缀
F). 资源命名
a).Pascal 风格
b). 仅使用字母、数字和下划线
c). 在命名异常信息的资源时,资源标识符应该是异常类型名加上简短的异常标识符
d). 不要给枚举类型值的名称加前缀
G). 数据库命名
a). 表 模块名_表名
b). 字段 布尔类型用 Is、Can、Has 等表示;日期类型命名必须包含 Date;时间类型必须包含 Time
c). 存储过程 使用 proc_前缀
d). 视图 使用 view_前缀
e). 触发器 使用 trig_前缀
H).XML 命名
a). 节点 Pascal 风格
b). 属性 Camel 风格
4). 注释
A). 对接口和复杂代码块必须进行注释
B). 修改代码时保持注释同步
C). 未完成的功能使用 TODO 标记
D). 修改他人代码时要先注释对方代码,并写明修改原因,不允许随便删除他人代码
E). 发布前移除无用注释
5). 异常处理
A). 四种异常类型
a).InvalidOperationException 无效操作
b).ArgumentException 参数无效
c).ArgumentNullException 参数值不能为 NULL
d).ArgumentOutOfRangeException 参数越界
B). 在自定义异常时,必须使用 VS 提供的代码模板来创建自定义异常

退出移动版