写一个质量高的代码, 关键之一是可读性.
可读性的关键之一是你要有一个好的且固定的代码规范:
首先 C# 中的命名约定有两种:
Pascal: 每个单词的首字母大写, 例如 ProductType;
Camel: 首个单词的首字母小写, 其余单词的首字母大写, 例如 productType
1. 缩进不用 tab 建, 使用四个空格作为缩进
2. 类中的私有成员变量 (private) 和内部成员变量 (internal) 使用_camelClass 也就是在 Camel 约定上加一个下划线. 而且私有的和内部的成员变量尽可能加上 readonly 修饰词.
3. 类中的静态成员变量命名使用 s_xxx , 并且修饰词应该是 static readonly
4. 类中的公共成员变量命名使用 Pascal 约定
5. 尽量不要出现 this.
6. 类中的变量第一个修饰符都是访问修饰符, 且任何变量必须要有访问修饰符, 也就是 public,private,internal
7. 命名空间要按照字母的顺序排序
8. 程序中不要有两个空行
9. 使用关键字定义而不是使用类定义, 比如 string a, 而不是 String a
10. 定义常量使用 Pascal 约定
11. 使用 nameof 拒绝硬编码
12. 注释
- /// <summary>
- /// 用于从 ERP 系统中捞出产品信息的类
- /// </summary>
以后遇到再继续记录和更新
来源: http://www.bubuko.com/infodetail-2636672.html