c#语言编码规范

《c#语言编码规范》由会员上传分享，免费在线阅读，更多相关内容在应用文档-天天文库。

1、C#编码规范-11-C#编码规范1.简介1.1总则本规范是实训体系编码规范系列中的一部分。实训体系编码规范系列包括C语言编码规范，HTML与JAVASCRIPT编码规范，JAVA编码规范，C#编码规范，ASP.N-ET编码规范，SQLServer编码规范，Oracle编码规范。编码规范用于提供统一编码标准，旨在指导实训体系学生的源代码文件的规范，以保证开发团队的协作和系统的后期维护能有效进行，编码规范同时作为代码评审的依据。1.2目的本规范提供一个C#语言编码的统一标准，目的在于在软件开发过程中基于C#语言的代码能够始终在整个开发团队中保持一致。1.3适用范围本规范适用于实

2、训体系内所有应用C#语言的项目开发与评审活动。2.格式2.1缩进所有的缩进皆为4个空格。对应的括号通常在同一列的位置上。例如：1）所有的缩进都用"Tab键"形成。2）所有的if、while和for语句中的语句内容必须用括号括起来，就算只有一个语句。#001if(superHero==theTick)#002{#003System.out.println("Spoon!");#004}2.2间隔所有的标识符都必须被空白字符包围。例如：#001inttheTick=5;#002if(theTick==5)2.3空行1）在逻辑代码段之间放置空行来分隔代码段；2）在两个方法/函数/

3、过程之间以空行来分割；3）在两个类或接口的定义之间放置空行来分隔；C#编码规范-11-4）命名空间引入完毕之后放置空行。2.4空格的位置1）在一个关键字和左括号“（”之间。注意：不要在方法名和左括号之间加空格。2）在参数列表的每个逗号“，”之后。3）二元操作符前后。注意：一元操作符前后都不加空格。例如：inta=10;a=a+1;a++;4）for语句的每个表达式之间。例如：for(inti=0;i<20;i++)…。2.5类成员的摆放顺序classOrder{1.staticfields2.staticproperties3.staticmethods4.staticco

4、nstructors5.fields6.properties7.constructors8.methods}9.必须保持private方法被放置在使用该方法的其他方法之上，而在构造器（constr-uctor）之下，即使该构造器有可能调用这些private方法。2.6文件格式文件注释必须第一个存在。接着是命名空间的定义。在命名空间首先应该using指令再次，是类型的注释；示例：#001/***************************************#002文件注释#003****************************************/#00

5、4namespacetestMail#005{#006usingSystem;#007#008///

6、用括号的目的必须是在表达上不但能够标明优先顺序，而且有助于使表达更简单明了。另外，如果某一段代码有可能产生歧义，也需加括号。3.命名规则3.1基本原则除了以下几个特例之外，命名时应始终采用完整的英文描述。此外，一般应采用小写字母，但类名、接口名以及任何非初始单词的第一个字母要大写。注意：不要将同一变量用作多个用途。（如Dataset类型，每查询一次就要声明一个变量。）l使用完整的英文描述符；l采用适用于该领域的术语；l尽量少用缩写，但如果用了，要明智地使用；l避免使用长的名字（小于30个字母）；l避免使用类似的名字，或者仅仅是大小写不同的名字；l避免使用下划线；3.2大小写

7、使用下面的三种大写标识符约定：lPascal大小写：将标识符的首字母和后面连接的每个单词的首字母都大写。可以对三字符或更多字符的标识符使用Pascal大小写。例如：BackColorlCamel大小写：标识符的首字母小写，而每个后面连接的单词的首字母都大写。例如：backColorl大写：标识符中的所有字母都大写。仅对于由两个或者更少字母组成的标识符使用该约定。例如：System.IO下表（表1）汇总了大写规则，并提供了不同类型的标识符的示例。标识符大小写示例C#编码规范-11-类PascalAppDomain枚举