软件编码规范模板.pdfVIP

1.简介

本规范为一套编写高效可靠的C#代码的标准、约定和指南。它以安全可

靠的软件程原则为基础，使代码易于理解、维护和增强，提高生产效率。同时，

将带来更大的一致性，使软件开发团队的效率明显提高。

2.适用范围

本规范适用于公司所有的C#源代码，为详细设计，代码编写和代码审核提

供参考和依据。

3.代码组织与风格

3.1.Tab

要使一个Tab为4个空格长。

3.2.缩进

要使一个代码块内的代码都统一缩进一个Tab长度。

3.3.空行

建议适当的增加空行，来增加代码的可读性C

在在类，接口以及彼此之间要有两行空行：

在下列情况之间要有一行空行：

方法之间；局部变量和它后边的语句之间；方法内的功能逻辑部分之间；

3.4.函数长度

每个函数有效代码（不包括注释和空行）长度不要超过50行。

4.注释

4.1.注释的基本约定

注释应该增加代码的清晰度；保持注释的简洁,不是任何代码都需要注释

的，过多的注释反而会影响代码的可读性。注释不要包括其他的特殊字符。建议

先写注释，后写代码，注释和代码一起完成如果语句块（比如循环和条件分枝的

代码块）代码太长，嵌套太多，则在其结束}要加上注释，标志对应的开始

语句如果分支条件逻辑比较复杂，也要加上注释C

4.2.注释类型

4.2.1,块注释

主要用来描述文件，类，方法，算法等，放在所描述对象的前边。具体格式

以

IDE编辑器输入7//”自动生成的格式为准，另外再附加我们自定义的格

式，

如下所列：〃/〈Remark〉作者,创建日期，修改日期＜/Remark＞对类

和接口的注释必须加上上述标记，对方法可以视情况考虑

4.2.2.行注释

主要用在方法内部，对代码，变量，流程等进行说明。整个注释占据一行。

4.2.3.随注释

与行注释功能相似，放在代码的同行，但是要与代码之间有足够的空间，便

于分

清。例：intm=4;//注释如果一个程序块内有多个尾随注释，每个注释

的缩进要保持一致。

4.3.程序修改注释

新增代行的前后要有注释行说明，对具体格式不作要求，但必须包含作者,

新

增时间，新增目的。在新增代的最后必须加上结束标志；删除代行的前

后要用注释行说明，删除代用注释原有代的方法。注释方法和内容同新增；

删除的代行建议用#regionXXX#endregion代段折叠，保持代文件干

净整洁修改代行建议以删除代行后再新增代行的方式进行（针对别人的代

进行修改时，必须标明，对于自己的代进行修改时，酌情进行）。

5.命名

5.1.命名的基本约定

要使用可以准确说明变量/字段/类的完整的英文描述符，如firstNameo对

一些

作用显而易见的变量可以采用简单的命名，如在循环里的递增（减）变量就

可以

被命名为i〃。要尽量采用项目所涉及领域的术语。要采用大小写混合，

提高名字的可读性。为区分一个标识符中的多个单词，把标识符中的每个单词的

首字母大写。不采用下划线作分隔字符的写法。有两种适合的书写方法，适应于

不同类型的标识符：PasalCasing:标识符的第一个单词的字母大写；

camelCasing:标识符的第一个单词的字母小写。避免使用缩写，如果一定要

使用，就谨慎使用。同时，应该保留一个标准缩写的列表，并且在使用时保持一

致。对常见缩略词，两个字母的缩写要采用统一大小写的方