DotNet编码规范

《DotNet编码规范》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、C#编码规范南方软件精英实验室二零一三年十月目录1目标42概述43总体要求43.1程序结构化43.2代码可读性43.3代码结构化43.4正确性与容错性54编码规范54.1文件结构54.1.1C#文件54.1.2目录结构54.2缩进54.2.1换行54.2.2空格64.3注释64.3.1模块注释64.3.2单行注释74.3.3类注释74.3.4方法注释74.4声明74.4.1单行声明变量数74.4.2初始化84.4.3类和接口声明84.5功能语句94.5.1简单逻辑94.5.2if-else语句94.5.3For/Foreach语句94.5.4While/do-wh

2、ile语句94.5.5Switch语句104.5.6Try-catch语句104.6空白114.6.1空白行114.6.2参数条件之间的空白114.6.3表格式的样式124.7命名规范124.7.1大写124.7.1.1Pascal风格124.7.1.2驼峰规则124.7.1.3大写风格124.7.2命名方法124.7.2.1类命名134.7.2.2接口命名134.7.2.3枚举命名134.7.2.4常量命名134.7.2.5参数命名134.7.2.6变量命名134.7.2.7方法命名134.7.2.8属性命名144.7.2.9事件命名144.7.2.10大写风格

3、144.8开发习惯144.8.1可见性144.8.2不要硬编码数字154.9代码示例154.9.1作用域（“{}”）示例155附录165.1XML注释标记的使用166版本记录191目标为新宇DotNet组的C#程序员制定一个统一的编码规范，最大限度减少不同程序员开发的代码间的差异。2概述为了使应用程序的结构和编码风格标准化，便于阅读和理解编码，以提高开发效率和产品的标准化，制订一套开发规范和标准势在必行。此外，好的编码约定可使源代码严谨、可读性强且意义清楚，与其它语言约定相一致，并且尽可能的直观。希望开发人员严格遵守此套开发规范和标准，并落实到自己的程序中。本规范

4、主要针对C#程序员，但是其中许多规则同时适用于其他语言的程序员。3总体要求3.1程序结构化·程序结构清晰，函数功能简单易懂（单个函数的代码行数不超过100行）3.2代码可读性·保持注释与代码完全一致·每个源程序文件，都有文件头说明，详细见下节·每个函数，都有函数头说明，详细见下节·主要变量（结构、联合、类或对象）定义或引用时，注释能反映其含义·处理过程的每个阶段都有相关注释说明·在典型算法前都有注释,同时算法在满足要求的情况下尽可能简单·利用缩进来显示程序的逻辑结构，缩进量一致并以Tab键为单位，定义Tab为4个字节·循环、分支层次一般不应超过五层·代码简单的分支

5、应该写在前面·不允许同行出现两个语句·空行和空白字符也是一种特殊注释·一目了然的语句不加注释·注释的作用范围可以为：定义、引用、条件分支以及一段代码·常量定义（DEFINE）有相应说明3.3代码结构化·禁止GOTO语句·用CASE实现多路分支·避免不必要的分支·用IF语句来强调只执行两组语句中的一组。尽量不使用ELSERETURN·尽量避免从循环引出多个出口1.1正确性与容错性·所有变量在调用前必须被初始化·不要比较浮点数的相等，如：10.0*0.1==1.0，不可靠·访问外部资源(数据库，外部文件)时使用规范的容错语句例如:try{}catch{}finally

6、{}2编码规范2.1文件结构2.1.1C#文件尽量不要让你的类或者文件太长,一般不应超过2000行代码。请按照功能划分你的代码，使结构保持清晰。一般情况下，一个文件应当只有一个类，并且文件名应该与类名保持一致。2.1.2目录结构应该为每个名称空间(namespace)建立一个目录(例如，我们可以为名称空间MyProject.TestSuite.TestTier建立这样的目录：MyProject/TestSuite/TestTier)。这样做可以让你很快定位到指定名称空间下的类文件。2.2缩进2.2.1换行如果表达式太长而一行无法写下时，请按照下列规范进行换行：l可

7、以在逗号后面进行换行l可以在操作符号后进行换行l尽量选择在较高层处进行换行l换行后的新行应当与前一行中同级别的运算符对齐例子：方法调用换行：longMethodCall(expr1,expr2,               expr3,expr4,expr5);算术表达式换行：规范的:var=a*b/(c-g+f)+      4*z;不规范的:var=a*b/(c-g+      f)+4*z;上面第一个表达式的换行方式是符合规范的，它换行在括号外面（较高层）。另外请注意，换行后的新行应使用tab和空格保持与前一行的同级运算符对齐，例如:>var=a*b/(c-

8、g+f)+