代码规范
-
用Tab作为缩进，并设置缩进大小为4：
缩进 - 换行，当一个表达式超过一行时，根据以下原则进行处理：
- 在逗号后换行
- 在操作符后换行
- 在高层换行儿不是在低层换行
- 折行后对其上一行语句同一层表达式的起始位置
- 类成员排列顺序
- 字段
- 属性
- 事件
- 构造函数
- 方法
- If\else\else if\for\while\do等语句自占一行，左花括号必须占一行，并且在同一列，括号内容为空时可在一行
- 空行分隔不同逻辑程序块，是程序块布局更加清晰
- 尽量使类文件大小控制在300~400行，避免方法太长，尽量提出至更小的方法，使单个方法只完成一个任务
注释
- 类型、属性、事件、方法、方法参数，根据需要添加XML注释
- 如果类、属性、事件、方法、方法参数的名称已经自注释了，可不加注释
- 注释符与注释内容之间要用一个空格进行分隔
- 正例
/*
注释内容
*/
// 注释内容 - 反例
/注释内容/
//注释内容
- 正例
-
包含在{}中代码块的结束处应加注释，便于阅读。特别多分支，多重嵌套的条件语句和循环语句
代码块注释
命名规则
- 类名与文件名保持一致
- 抽象类以Abstract为前缀或者以Base为后缀命名
- 异常类型以Exception为后缀
- 所有命名空间、类型名称使用Pascal风格
- 不使用缩写，所有类、字段、属性、方法、事件尽量不适用缩写，包括大家熟知的缩写， 如msg
- 方法名用大写字母开头的单词组合而成，且应当使用“动词”或者“动词+名词”动宾词组
- 不使用单个字母的变量，使用完整含义的词，不使用单个字母的变量，像i，m，n使用index等来替换，用于循环迭代的变量除外
- 本地变量、方法参数名使用Camel风格（不使用下划线）
- 类内部的私有变量和受保护字段，使用Camel分隔，加“_”前缀
- 常量名都要使用大写字母，用下划线‘_’分割单词，如MIN_VALUE。
- 静态字段或属性使用Pascal风格，首字母大写
- 接口命名在名字前加上“I”前缀，其他与类命名规则相同
- 委托和事件命名
- 委托以EventHandler作为后缀命名，例如 SaleOutEventHandler
- 事件以其对应的委托类型，去掉EventHandler，并加上On前缀构成，例如 OnSaleOut
- 返回bool类型的方法、属性命名
- 方法以Is前缀，例如IsHidden
- 属性以Can前缀， 例如CanHidden
- 程序中不要出现仅靠大小写区分的相似的标识符
-
用正确的反义词组命名具有互斥意义的变量或相反动作的函数等
互斥 -
空间命名应采用完整的英文描述命名，名字的前缀是控件类型名缩写
控件命名 -
常见集合后缀类型命名
集合后缀类型
表达式及语句
-
在表达式中使用括号，使表达式的运算顺序更清晰
表达式 - 不在for循环体内修改循环变量，防止for循环失去控制
其他
- 不能出现共有字段，共有字段必须以属性包装
- 不在代码中使用具体的路径和驱动器名，使用相对路径，并使其能复用
- 不要捕捉异常后什么也不做
