C#编程规范解释.docVIP

名字 签名 日期 设 计： 2016/04/26 审 核： 组 审： 室 审： 历史版本 版本 日期 状态 变化的内容或注释 2016/04/26 提交 首次提交 目录 1.0 前言 3 1.1 总述 3 1.2 设计人认可 3 2.0 代码书写规则 4 3.0 命名规范 5 4.0 注释规范 8 5.0 排版 9 6.0 控件命名规则 10 前言 总述 规范制定原则：方便代码的交流和维护；不影响编码的效率，不与大众习惯冲突；使代码更美观、阅读更方便；使代码的逻辑更清晰、更易于理解。 设计人认可 所有的设计标准应该保持严格的一致。为了确保相同的设计标准贯穿整个项目，如果有任何偏差、修改、删除或增加都必须经过设计人批准。如果设计人同意并认可更改，他将更新并重新发布更新后的标准。 代码书写规则 尽量使用接口，然后使用类实现接口，以提高程序的灵活性。 一行不要超过80个字符。 尽量不要手工更改计算机生成的代码，若必须更改，一定要改成和计算机生成的代码风格一样。 关键的语句（包括声明关键的变量）必须要写注释。 建议局部变量在最接近使用它的地方声明。 不要使用goto系列语句，除非是用在跳出深层循环时。 避免写超过5个参数的方法。如果要传递多个参数，则使用结构。 避免书写代码量过大的try-catch模块。 避免在同一个文件中放置多个类。 生成和构建一个长的字符串时，一定要使用StringBuilder类型，而不用String类型。 Switch语句一定要有default语句来处理意外情况。 对于if语句，应该使用一对“ ”把语句块包含起来。 尽量不使用this关键字引用。 命名规范 用Pascal规则来命名方法和类。 Pascal规则：将标识符的首字母和后面连接的每个单词的首字母都大写。BackColor 命名示例：public void Test class TestManager 用Camel规则来命名局部变量和方法的参数。 Camel规则：标识符的首字母小写，而每个后面连接的单词的首字母都大写。backColor 命名示例：string strUserName; 对于string类型定义，通常使用str前缀 而对于此外的类型对象定义，通常的做法是使用obj前缀＋Pascal命名的方式，来告知我们这个变量是一个对象。 Application objApplication new Application ; 数据成员命名以Camel命名方式，而属性以Pascal命名。 public ArrayList WorksheetCollection get return this.worksheetCollection; 接口的名称加前缀“I”。 命名示例：interface IStudentInformation 所有的成员变量前加前缀“_”。 命名示例：class TestManager private int _old; private string _strUserName; 方法的命名，一般将其命名为动宾短语。 命名示例：public void ShowInfo 所有的成员变量声明在类的顶端，用一个换行把它和方法分开。 命名示例：class TestManager private int _old; private string _strUserName; public void ShowInfo 用有意义的名字命名空间namespace，例如公司名，产品名。命名空间的命名使用Pascal格式。 命名示例：namespace Manager 使用某个控件的值时，尽量命名局部变量。 命名示例：string strTitle textBox1.text; （10）委托的命名方式常常以Pascal命名，并且在命名的后面加EventHandler。 命名示例：public delegate void MouseEventHandler object sender, MouseEventArgs e ;? （11）自定义异常类以Exception结尾并且在类名中能清楚的描述出该异常的原因。 NotFoundFileException （12）枚举的命名是Pascal命名，不需要在枚举中加入Enum，枚举的名称能清楚的表明该枚举的用途。? enum Direction UP 1, RIGHT 2, DOWN 3, LEFT 4, ; 13 常量命名全部大写，单词间以下划线间隔。 命名示例：public const int LOCK_SECONDS 3000; 14 在一般情况下，不推荐缩写命名，不要担心变量命名长，长的变量名能使变量的意义更加清晰。 命名示例：int productTypeCount