文件名称:最全面的C#程序编码规范
文件大小:182KB
文件格式:DOC
更新时间:2017-10-25 16:40:53
C#程序
为了保证所每个项目组编写出的程序都符合相同的规范,便于提高代码的可读性和可维护性,便于检查、减少出错概率,有助于项目组成员间交流,保证一致性、统一性而建立的C#程序编码规范。 二、 范围 该规范适用于所有基于C#开发的.Net平台项目,为详细设计,代码编写和代码审核提供参考和依据。 三、 规范内容 1、代码格式 1.1、要使所有的缩进为一个Tab,即4个空格,使用VS.NET的默认设置。 1.2、在代码中垂直对齐左括号和右括号。 if (x == 0) { Response.Write("用户编号必须输入!"); } 不允许以下情况: if (x == 0) { Response.Write("用户编号必须输入!"); } 或者: if (x == 0){ Response.Write("用户编号必须输入!");} 1.3、为了防止在阅读代码时滚动源代码编辑器,每行代码或注释在1024*768的分辨率下尽量不超过一显示屏,如超过则应换行,换行后的代码应该缩进一个Tab。 1.4、当一行被分为几行时,将串联运算符放在每一行的末尾而不是开头,清楚地表示没有后面的行是不完整的。 1.5、每一行上放置的语句避免超过一条,避免写 int i = 0;int j = 1; 1.6、在大多数运算符之前和之后使用空格,这样做时不会改变代码的意图却可以使代码容易阅读。例: int j = i + k; 而不应写为 int j=i+k; 1.7、将大的复杂代码节分为较小的、易于理解的模块。 1.8、编写 SQL 语句时,建议(不强求)对于关键字使用全部大写,对于数据库元素(如表、列和视图)使用大小写混合。 1.9、将每个主要的 SQL 子句放在不同的行上,这样更容易阅读和编辑语句,例如: SELECT FirstName, LastName FROM Customers WHERE State = 'WA'