编码规范及其代码.docx

项目编号 200602006 文档编号 13 密 级 内部 选课系统编码规范及其代码说明 目 录 1.导言 1.1目的 1.2范围 1.3缩写说明 1.4术语定义 1.5引用标准 1.6参考资料 1.7版本更新信息 2. 编码格式规范 3.命名规范 3. 1命名的基本约定 3. 2各种标示符类型的命名约定 3. 3组件名称缩写列表 4．声明规范 4.1变量声明 4.2代码缩进 4.3空白 5．语句规范 6.注释规范 6. 1注释的方法 6. 2开头注释 6. 3类和接口的注释 7.目录规范 导言 1.1目的 该文档的目的是描述网上招聘系统项目的编码规范和对代码的说明，其主要内容包括： 编码规范 命名规范 注释规范 语句规范 声明规范 目录设置 代码说明 本文档的预期的读者是： 开发人员 项目管理人员 质量保证人员 1.2范围 该文档定义了本项目的代码编写规范，以及部分代码描述和所有代码的说明。 1.3缩写说明 Aspx Aspx是Active Server Pages XML的缩写。 1.4术语定义 Class C#程序的单元。 Packages 由很多的类组成的工作包。 1.5引用标准 [1] 《企业文档格式标准》 北京长江软件有限公司 1.6参考资料 书名：《系统分析设计技术》 作者：张友生 《C#程序设计》 2. 编码格式规范 1．代码书写格式 （1）所有的缩进TAB键为4个空格，每个单词的首字符大写，其余小写。（2）在代码中垂直对齐左括号和右括号。 例： if(x==0) { Response.Write(用户名必须输入！); } 不允许以下情况： if(x==0) { Response.Write(用户名必须输入！); }或者 if(x==0) { Response.Write(用户名必须输入！); } （3）在大多数运算符之前和之后使用空格，这样做时不会改变代码的的意图却可以使代码容易阅读。例：int j = i + k;而不应写为：int j=i+k; （4）缩写SQL语句时，对于关键字使用全部大写，对于数据库元素（如表，列和视图）使用大小写混合）。 （5）将每个主要的SQL子句放在不同的行上，这样更容易阅读和编辑语句。 2.注释的写法 （1）在你劳神的地方请加上详细的注释说明，除了最简单的存取成员变量的Set/Get成员函数之外，其余大部分的函数写上注释是良好的习惯，尽量使你的程序让别人很容易看懂。 （2）大多的注释会使很难看，但一些复杂的算法和数据结构和数据结构处还是要加上注释的，这样别人就容易看懂，否则时间长了，你自己都未必卸载明白了。 （3）如果是对某一段程序（算法/结构）的注释，在程序头直接用//再空一格进行说明，一行不要超过80个字符。 （4）为了防止在阅读代码时不得不左右流动源代码编辑器，每行代码或注释在不得超过一显示屏。 （5）使用连续的多个/表示注释行（不要超过80字符）。 （6）文件头部应有注释，简单描述文件的内容（7）对于程序中的比较关键的算法和函数，必须加注释。 3．cs文件的书写 （1）各个部分应使用注释行和空行分割，并在必要的地方写上注释。 （2）函数之间用注释各空行分割。中间的内容缩进一个TAB三.其他1.变量 (1)float和bool禁止用==判断.bool应该用逻辑运算关系符,而float应该用差值区间来判断相等; (2)类型转换一律用显示类型转换 (3)类型的长度一律用sizeof()获得; (4)当声明一个变量时,务必要自已初始化一下变量; 2.函数 (1)功能单一,函数名要名符其实. (2)要易懂,实现时要根过分追求技巧,优化放到后面去做 .(3)长度一般禁止超过200行. (4)要检查输入值是否合法,实现(成员)函数时务必要求输入参数是在要求范围之内,尤其你定义的(成员)函数给别人调用时,要判断其合法性. (5)调用函数时要严格按照接口规范调用,调用后要判断执行情况,并做适当的错误处理(尔后会给出错误和异常处理规范) (6)尽量避免整块复制代码段,如果出现这样的情况要分析原因,如果这段代码完成独立的功能,应考虑使用函数,否则,应考虑使用宏定义,否则因为修改引起的不一致往往是错误的根源 .(7)除极其简单的函数外,其他的函数在稿处必须加上FMAT_TARCE(),参见错误异常处理规范 .(8)函数的出口尽量唯一,最好在出口处加上FMAT_TRCE(); (9)写代码时,尽量减少堆的分配次数,能使用Stack的尽量使用Stack (10)函数编写必须精练,消除冗余的代码,删除不用的变量 (11)if