2020/06/29

C#命名规则和编码规范

  • 用Pascal规则来命名属性、方法、事件和类名
  • 用Camel规则来命名成员变量、局部变量和方法的参数
  • 不要将常量或者只读变量的变量名全部大写,而使用Pascal规则来命名
  • 接口的名称一般以大写I作前缀
  • 自定义的属性以Attribute结尾
  • 自定义的异常以Exception结尾
  • 类的命名。用名词或名词短语来命名类名
  • 方法的命名。一般将其命名为动宾短语
  • 局部变量的名称要有意义
    不要直接用用i,j,k,l,m,n,x,y,z等做变量名,但for循环除外
  • 代码分块
    所有的成员变量声明在类的顶端,用一个换行把它和方法分开。同时可以使用成对的#region...#endregion标记,方便折叠。
  • 布尔型变量或者方法一般可以用is、can、has或者should做前缀。如,isFinished, canWork等。
  • 判断条件是一个布尔变量时不要使用==进行条件判断
  • 慎用缩写
    变量名是一个单词的尽量不要缩写,多单词组成的变量名可适当缩写。
  • 在类的顶部声明所有的成员变量,静态变量声明在最前面
  • 方法的书写规范
    如果一个方法超过25行,就需要考虑是否可以重构和拆分成多个方法。方法命名要见名知意,好的方法名可以省略多余的注释。方法功能尽量单一。

摘自:https://www.jianshu.com/p/dc26cb8ffcb9 只保留了认同的内容,部分不认同所以删除了。

没有评论: