编辑推荐您关注:
本文由读书人编辑为您精心准备,请大家参考!
1、目的
为了保证技术部编写出的程序都符合相同的规范,保证一致性、统一性而建立的程序编码规范。
2、范围
适用于技术部所有基于.NET平台的所有开发工作。
3、规范内容
3.1、代码格式
•所有的缩进为4个空格,使用VS.NET的默认设置。
•在代码中垂直对齐左括号和右括号。
if(x==0)
{
Response.Write("用户编号必须输入!");
}
不允许以下情况:
if(x==0){
Response.Write("用户编号必须输入!");
}
或者:
if(x==0){Response.Write("用户编号必须输入!");}
•为了防止在阅读代码时不得不滚动源代码编辑器,每行代码或注释在1024*800的显示频率下不得超过一显示屏
•当一行被分为几行时,通过将串联运算符放在每一行的末尾而不是开头,清楚地表示没有后面的行是不完整的。
•每一行上放置的语句避免超过一条。
•在大多数运算符之前和之后使用空格,这样做时不会改变代码的意图却可以使代码容易阅读。
例:intj=i+k;
而不应写为:intj=i+k;
•将大的复杂代码节分为较小的、易于理解的模块。
•编写SQL语句时,对于关键字使用全部大写,对于数据库元素(如表、列和视图)使用大小写混合。
•将每个主要的SQL子句放在不同的行上,这样更容易阅读和编辑语句,例如:SELECTFirstName,LastName
FROMCustomers
WHEREState='WA'
•编写HTML时,建立标准的标记和属性格式,如所有标记都大写或所有属性都小写。另一种方法是,坚持XHTML规范以确保所有HTML文档都有效。尽管在创建Web页时需折中考虑文件大小,但应使用带引号的属性值和结束标记以方便维护。
3.2、注释(Comment)规范
注释规范包括:模块(类)注释规范、类的属性、方法注释规范、代码间注释
3.2.1.模块(类)注释规范
•模块开始必须以以下形式书写模块注释:
///
///模块编号:<模块编号,可以引用系统设计中的模块编号>
///作用:<对此类的描述,可以引用系统设计中的描述>
///作者:作者中文名
///编写日期:<模块创建日期,格式:YYYY-MM-DD>