通用编程规范

通用编程规范

一、总则：

1、使用一致的编码方法和好的编程做法来创建高质量代码在软件的品质和性能中起重要作用。

2、如果一致地应用正确定义的编码标准、应用正确的编码方法并在随后保持例行代码检查，则软件项目更有可能产生出易于理解和维护的软件系统。

二、命名规则：

1、命名原则是：

1）、使名称足够长以便有一定的意义，并且足够短以避免冗长。

2）、使用容易让人理解的名称，避免容易被主观解释的难懂的名称； 3）、尽量减少使用缩写；

4）、鉴于大多数名称都是通过连接若干单词构造的，请使用大小写混合的格式以简化它们的阅读。

2、类相关命名：

1）、在类的属性名称中包含类名是多余的，如Book.BookTitle，而是应该使用Book.Title；

2）、类名及属性使用名词；

3）、方法使用动词或是动+名词的方法来命名；

4）、方法名称、类名称每个单词的第一个字母都是大写的；

5）、命名方法时包括返回值的说明，比如使用GetXXXName()等。

3、变量命名：

1）、对于计算型变量名，在末尾追加计算限定符，如Avg、Sum、Min、Max、Index(Idx)；

2）、对于互补型变量或函数，使用互补对，如Min/Max、Begin/End、Open/Close、Get/Set；

3）、变量名除了第一个单词外每个单词的第一个字母都是大写的； 4）、布尔变量名应该包含Is，最好是以Is开头；

5）、对于状态变量，尽量限定在特定集合中使用xxxType，一般不要使用xxxFlag；

6）、生存期很短的变量仍然尽量使用有意义的名称，对于用于短循环索引的变量可以使用单字母变量名，如i、j、k。

三、注释规则：

1、说明：

1）、软件文档以两种形式存在：外部的和内部的；

2）、外部文档（如规范、帮助文件和设计文档）在源代码的外部维护；

3）、内部文档由开发人员在开发时在源代码中编写的注释组成；

2、推荐的注释方法：

1）、使用 XML 文档功能；

2）、修改代码时，总是使代码周围的注释保持最新；

3）、在每个函数的开始，说明函数的用途、假设和限制等；

4）、除了批注变量声明外，避免在代码行的末尾添加注释；

5）、在部署之前，移除所有临时或无关的注释；

6）、注释应该阐明代码，而不应该增加多义性；

7）、在编写代码时就注释，因为以后很可能没有时间这样做；

8）、避免多余的或不适当的注释，如幽默的不主要的备注；

9）、使用注释来解释代码的意图，而不是作为代码的联机翻译；

10）、为了防止问题反复出现，对错误修复和解决方法代码总是使用注释；

11）、对由循环和逻辑分支组成的代码使用注释。

四、书写格式：

1、总则：格式化使代码的逻辑结构很明显。

2、要求书写格式：

1）、使用四个空格作为标准的缩进大小，并一致地使用此标准；

2）、括号位于下一行，要求相匹配的大括号在同一列；

3）、每一行上放置的语句避免超过一条。

4）、对继行则要求再缩进4格。