C编码规范2.docVIP

C#编码规范目录1?????目的 32?????范围 33?????规范内容 33.1???????文件规范... 33.1.1???????文件命名... 33.1.2???????文件内容格式... 33.2???????代码格式... 43.3???????注释（Comment）规范... 53.3.1???????模块（类）注释规范... 53.3.2???????类属性注释规范... 63.3.3???????方法注释规范... 63.3.4???????代码间注释规范... 63.4???????变量（Variable）命名规范... 63.4.1???????程序文件(*.cs)中的变量命名规则... 63.4.2???????控件命名规则... 83.4.3???????常量命名规范... 93.4.4???????类（Class）命名规范... 93.4.5???????接口（Interface）命名规范... 103.4.6???????方法（Method）命名规范... 103.4.7???????命名空间（NameSpace）命名规范... 104?????实施建议 10 1????????目的 为了保证企业编写出的程序都符合相同的规范，保证一致性、统一性而建立的程序编码规范。编码规范对于程序员而言尤为重要，有以下几个原因：- 一个软件的生命周期中，80%的花费在于维护- 几乎没有任何一个软件，在其整个生命周期中，均由最初的开发人员来维护- 编码规范可以改善软件的可读性，可以让程序员尽快而彻底地理解新的代码- 如果你将源码作为产品发布，就需要确任它是否被很好的打包并且清晰无误，一如你已构建的其它任何产品 为了执行规范，每个软件开发人员必须一致遵守编码规范。每个人。 2?????????范围 适用于企业所有基于C#.NET平台的软件开发工作。 3?????????规范内容 3.1???????文件规范 3.1.1?????文件命名 与类名名称相同 3.1.2?????文件内容格式 开头注释引用命名空间类体变量(代理事件)：用#region 变量………#endregion包括属性：用#region属性………#endregion包括构造：方法(事件的实现)：用#region方法………#endregion包括 3.2???????代码格式 u???????所有的缩进为4个空格，以空格代替Tab 。选中”插入空格(P)”????????u???????在代码中垂直对齐左括号和右括号。if(x==0)??????????????{???????????????????Response.Write(用户编号必须输入！);??????????????}???????????不允许以下情况：if(x==0) {?????????????????????????????????Response.Write(用户编号必须输入！);??????????????}或者：if(x==0){ Response.Write(用户编号必须输入！);}u???????为了防止在阅读代码时不得不滚动源代码编辑器，每行代码或注释在1024*800的显示频率下不得超过一显示屏u???????当一行被分为几行时，通过将串联运算符放在每一行的末尾而不是开头，清楚地表示没有后面的行是不完整的。u???????每一行上放置的语句避免超过一条。u???????在大多数运算符之前和之后使用空格，这样做时不会改变代码的意图却可以使代码容易阅读。例：????????int j = i + k;而不应写为????int j=i+k;u???????将大的复杂代码节分为较小的、易于理解的模块。u???????编写 SQL 语句时，对于关键字使用全部大写，对于数据库元素（如表、列和视图）使用大小写混合。u???????将每个主要的 SQL 子句放在不同的行上，这样更容易阅读和编辑语句，例如： SELECT FirstName, LastName?????????????????????????????FROM Customers????????????????WHERE State = WA 3.3???????注释（Comment）规范 注释规范包括：模块（类）注释规范、类的属性、方法注释规范、代码间注释 3.3.1?????模块（类）注释规范 模块开始必须以以下形式书写模块注释：///summary///定义某某类的方法////summary///see cref=Author作者 /see///see cr