NET编码规范.docVIP

ASP.NET编码规范 2 第一章 编码规范概述 2 第二章 静态文件编码规范 2 1. HTML标记语言编码规范 2 1.1 标记的换行规范： 2 1.2 标记的关闭规范 3 1.3 标记的属性赋值规范 3 1.4 标记的缩进规范 3 2. 客户端JavaScript规范 3 2.1 变量命名规范 3 2.2 变量使用规范 4 2.3 对象命名规范 4 2.4 函数以及子过程命名规范 4 第三章 动态文件编码规范 5 1、命名规范 5 1.1、类的命名规范 5 1.2、变量命名规范 5 1.3、函数命名及使用规范 6 1.4、控件命名规范 6 2、注释规范 7 2.1、文件头部注释 7 2.2、函数、属性、类等注释 7 2.3、程序流程及逻辑点注释 8 3、缩进规范 8 4、异常处理规范 8 5、Request、Session、Application使用规范 10 第四章 文件命名规范 10 1．数据库命名规范 10 1.1、数据文件命名规范 10 1.2、数据库表命名规范 10 1.3、数据库字段命名规范 10 1.4、数据库视图命名规范 11 1.5、存储过程命名规范 11 1.6、SQL语句编写规范 11 2.文件夹及文件命名规范 11 2.1 图片的命名原则 11 2.2 动态语言文件命名规则 12 第五章 良好的编程习惯 13 1、避免使用大文件 13 2、避免写太长的方法 13 3、方法名需能看出它作什么 13 4、一个方法只完成一个任务 13 5、使用C# 或 VB.NET的特有类型 13 6、别在程序中使用固定数值 14 7、别用字符串常数 14 8、必要时使用enum 14 9、别把成员变量声明为 public 或 protected 15 10、不在代码中使用具体的路径和驱动器名 15 11、人性化消息提示 15 12、多使用StringBuilder替代String 15 ASP.NET编码规范 第一章 编码规范概述 ASP.NET编码分为两大部分，一部分为客户端的静态文件编码，另一部分为包含服务器端脚本的动态文件编码。静态文件编码分Script编码和HTML编码两部分。服务器端编码则分为服务器脚本、客户端脚本、HTML脚本三部分。 编码规范采用如下约定： 所有客户端脚本一律使用JavaScript 所有服务器端脚本一律使用C# 静态页面输出一律使用HTML脚本 本规范不适用于由服务器端脚本所产生的客户端脚本代码。 两种常用的命名法： Pascal命名法格式－所有单词第一个字母大写，其他字母小写。 Camel命名法格式－除了第一个单词，所有单词第一个字母大写，其他字母小写。 第二章 静态文件编码规范 输出部分采用HTML标记语言。静态文件脚本部分采用JavaScript编写。 1. HTML标记语言编码规范 1.1 标记的换行规范： * 一个标记必须占用一行。不得出现两个标记在同一行的情况(同一标记的关闭标记除外)，如： trtdtext/td/tr 而必须写成： tr tdtext/td /tr 1.2 标记的关闭规范 * 静态文件内容必须包含在body/body标记中间 * body标记必须包含在html/html标记中间 * 对于需要关闭的标记，如： 　　htmltitlebodytabletrtdptextareaselectfontoptiondivspan 　　必须同其关闭标记同时出现。如 　　body…p…font…./font…./p…../body * 不得出现交叉包含的语句，如： pfont…../p/font 1.3 标记的属性赋值规范 对于接受属性的标记，属性值必须使用双引号或者单引号包围。如: 　　body bgcolor=”red” 　　font size=’7’ 注意：必须确保属性的赋值无警告或错误。 1.4 标记的缩进规范 * 最高一级的父标记采用左对齐顶格方式书写。 * 下一级标记采用左对齐向右缩进一个Tab的方式书写 　　在下一级依此类推，分别左对齐相对于父标记向右缩进一个Tab的方式书写 * 同一级标记的首字符上下必须对齐。 注意：在进行代码缩进时，可使用VS2005及其以上版本的开发环境中的自动缩进功能。 2. 客户端JavaScript规范 2.1 变量命名规范 * 常量以及全局变量名必须全部使用大写字母 * 变量名首字母必须小写 * 变量名必须使用其类型的所写字符串开始。各种类型的所写字符串如下： * 整型变量：int * 长整型变量：l