走查项列表 符合 不符合 不符合说明 备注
程序结构
1 代码结构清晰,具有良好的可读性
2 所有业务功能需求都被明显覆盖
3 接 所有接口模块化,修改时不影响其他模块
4 具有统一的出错页面及异常处理机制
命名原则
5 除parameter外,所有命名遵循PascalCase原则。
6 不使用公共标识符和关键字命名
7 控件命名遵循编码规范。
8 类命名使用缩写,名词或名词短语。
9 接口命名使用字母H作前缀。
10 方法和函数命名使用动词或动词短语。
11 不使用单字符命名(for、foreach循环除外)
代码组织
12 每个文件包含文件头,包含文件名称、描述、作者、创建日期、修改历史记录等。
13 使用#region...#endregion对代码分类。
14 每行代码小于150个字符。
15 变量名小于32字符
16 每行只有一句代码或一个表达式
17 续行缩进,{}括号位置合适,上下对齐
18 顺序块用空行隔开,最好有注解
19 代码在逗号后、操作符前换行
20 每行只有一个声明,声明时初始化
21 不对数值硬编码,使用常量代替
函数组织
22 函数有详细注解,包括功能、参数、类型等。
23 函数名清晰定义目标和功能。
24 函数名小于64个字符
25 函数高内聚,只做一件事情
26 函数参数个数小于5个(特殊情况可稍多)
27 算法实现的功能说明清楚
数据类型与变量
28 数据类型与变量
变量命名清楚描述变量内容。
变量类型清晰,如intValue和strValue。
变量分配正确的长度、类型和存储空间。
不使用关键字或发音相似的变量名。
使用String.Empty替代""。
使用StringBuilder代替string处理长字符串。
全局变量描述清楚。
所有变量都被使用。
29 变量类型清晰,如intValue和strValue
30 变量分配正确的长度、类型和存储空间
31 不使用关键字或发音相似的变量名
32 使用String.Empty替代""
33 使用StringBuilder代替string处理长字符串
34 全局变量描述清楚
35 所有变量都被使用
条件判断
36 if/else使用正确。
37 使用()包含语句块,即使只有一条语句
38 普通情况在if下处理,非在else下
09-15
05-29