《ASPNET编码规范.doc》由会员分享，可在线阅读，更多相关《ASPNET编码规范.doc（17页珍藏版）》请在金锄头文库上搜索。
1、ASP.NET编码规范2第一章 编码规范概述2第二章 静态文件编码规范21. HTML标记语言编码规范21.1 标记的换行规范：21.2 标记的关闭规范31.3 标记的属性赋值规范31.4 标记的缩进规范32. 客户端JavaScript规范32.1 变量命名规范32.2 变量使用规范42.3 对象命名规范42.4 函数以及子过程命名规范4第三章 动态文件编码规范51、命名规范51.1、类的命名规范51.2、变量命名规范51.3、函数命名及使用规范61.4、控件命名规范62、注释规范72.1、文件头部注释72.2、函数、属性、类等注释72.3、程序流程及逻辑点注释83、缩进规范84、异常处理规
2、范85、Request、Session、Application使用规范10第四章 文件命名规范101数据库命名规范101.1、数据文件命名规范101.2、数据库表命名规范101.3、数据库字段命名规范101.4、数据库视图命名规范111.5、存储过程命名规范111.6、SQL语句编写规范112.文件夹及文件命名规范112.1 图片的命名原则112.2 动态语言文件命名规则12第五章 良好的编程习惯131、避免使用大文件132、避免写太长的方法133、方法名需能看出它作什么134、一个方法只完成一个任务135、使用C# 或 VB.NET的特有类型136、别在程序中使用固定数值147、别用字符串常
3、数148、必要时使用enum149、别把成员变量声明为 public 或 protected1510、不在代码中使用具体的路径和驱动器名1511、人性化消息提示1512、多使用StringBuilder替代String15ASP.NET编码规范第一章 编码规范概述ASP.NET编码分为两大部分，一部分为客户端的静态文件编码，另一部分为包含服务器端脚本的动态文件编码。静态文件编码分Script编码和HTML编码两部分。服务器端编码则分为服务器脚本、客户端脚本、HTML脚本三部分。编码规范采用如下约定： 1. 所有客户端脚本一律使用JavaScript 2. 所有服务器端脚本一律使用C#3. 静态
4、页面输出一律使用HTML脚本4. 本规范不适用于由服务器端脚本所产生的客户端脚本代码。两种常用的命名法：Pascal命名法格式所有单词第一个字母大写，其他字母小写。Camel命名法格式除了第一个单词，所有单词第一个字母大写，其他字母小写。第二章 静态文件编码规范输出部分采用HTML标记语言。静态文件脚本部分采用JavaScript编写。1. HTML标记语言编码规范 1.1 标记的换行规范： * 一个标记必须占用一行。不得出现两个标记在同一行的情况(同一标记的关闭标记除外)，如： text 而必须写成： text 1.2 标记的关闭规范 * 静态文件内容必须包含在标记中间 * 标记必须包含在标
5、记中间 * 对于需要关闭的标记，如： 必须同其关闭标记同时出现。如 . * 不得出现交叉包含的语句，如： . 1.3 标记的属性赋值规范 对于接受属性的标记，属性值必须使用双引号或者单引号包围。如: 注意：必须确保属性的赋值无警告或错误。1.4 标记的缩进规范 * 最高一级的父标记采用左对齐顶格方式书写。 * 下一级标记采用左对齐向右缩进一个Tab的方式书写 在下一级依此类推，分别左对齐相对于父标记向右缩进一个Tab的方式书写 * 同一级标记的首字符上下必须对齐。 注意：在进行代码缩进时，可使用VS2005及其以上版本的开发环境中的自动缩进功能。2. 客户端JavaScript规范 2.1 变
6、量命名规范 * 常量以及全局变量名必须全部使用大写字母 * 变量名首字母必须小写 * 变量名必须使用其类型的所写字符串开始。各种类型的所写字符串如下： 整型变量：int 长整型变量：lng 浮点型变量：flt 双精度变量：dbl 对象引用变量：obj 字符串变量:str Date类型变量：dtm * 变量名必须采用有意义的单词命名，如： strUserName、lngArrayIndex * 变量名除首字母小写外，其他单词首字符必须大写 * 如果变量名过长可以使用单词缩写，除了被广泛了解的单词缩写以外，所有使用单词所写的变量名必须在定义时给出注释,如： var strAdName /用于表示A
7、dministrator帐户的名称 var strAdminName /不用给出注释，Admin被广泛了解 2.2 变量使用规范 * 变量使用前必须定义。没有定义的变量禁止使用 * 变量的使用尽量缩小到小的作用域。如循环使用 for(var I=0;I12;I+) 而不是： var I; for(I=0;I12,I+) 2.3 对象命名规范 各种页面对象如text输入框、按钮、下拉选择框在命名时必须使用以下对应前缀： * text输入框:txt * button按钮：btn * select下拉选择框：sel * option项:opt * form表单：frm * frame框架：fra *
8、 hidden表单项：hdn * div标记：div * span标记:spn * 对话框对象:dlg * 窗口对象：wnd 2.4 函数以及子过程命名规范 * 函数的命名采用Pascal命名格式，命名内容格式使用动词名词对的方式，且命名能够体现函数的功能 * 函数命名的动词前缀必须是同函数功能相关的完整动词 如：GetUserName，CreateNewUser，UpdateUserInfos第三章 动态文件编码规范1、命名规范1.1、类的命名规范* 类名使用Pascal命名法。如：public class HelloWorld .* 以Class声明的类，都必须以名词或名词短语命名，体现类
9、的作用。如： Class Indicator* 当类只需有一个对象实例（全局对象，比如Application等），必须以Class结尾，如：Class ScreenClassClass SystemClass* 当类只用于作为其他类的基类，根据情况，以Base结尾。如：Class IndicatorBase1.2、变量命名规范变量的基本命名规范：l 常量必须全部使用CONST_前缀。l 变量名首字母必须小写。l 变量名采用Camel命名法（除首字母小写外，其他单词首字符必须大写），命名格式：数据类型缩写+名词对。各种常见数据类型的缩写如下： * 整型变量：int * 长整型变量：lng * 浮
10、点型变量：flt * 双精度变量：dbl * 对象引用变量：obj * 字符串变量:str * Date类型变量：dtm l 变量名必须采用有意义的单词命名。如： strUserName、lngArrayIndexl 当变量名过长时，可使用单词缩写。但除了被广泛了解的单词缩写之外，所有缩写的变量名必须在定义的后面给出注释。如： dim strAdName 用于表示Administrator帐户的名称dim strAdminName 不用给出注释，Admin被广泛了解类的成员变量的特有命名规范： 类的所有成员变量前加下划线“_”，以区别于函数参数和函数中的局部变量。1.3、函数命名及使用规范1.
11、3.1、命名规范* 函数命名使用Pascal命名法。第一个单词的首字母大写，后面每一个单词的首字母大写。* 函数命名格式：动词一个或多个名词。注意：函数命名的动词前缀必须是同函数功能相关的完整动词。并且，函数的命名必须能够体现函数的功能。如：GetUserName(), CreateNewUser, UpdateUserInfosFromDatabase() 1.3.2、使用规则* 如果函数有传入参数，则必须在函数的头部判断参数的合法性，不合法则不继续操作，并给予响应的提示。* 尽量使用函数封装代码块* 连续代码块尽量不要超过50行。最多不得超过70行* 尽量使用局部变量。* 如有涉及到全局的
12、资源（如Connection），尽量作为函数的参数传入。* 所有在函数内部创建打开的资源，在退出函数前必须关闭释放。如：sqldatareader1.4、控件命名规范建议是使用控件名简写作为前缀，并且简写的首字母小写，并且整个名字符合Camel规范。控件命名格式：控件名简写前缀+英文描述注意：英文描述中的单词首字母大写主要控件名简写对照表控件名简写LabellblTextBoxtxtButtonbtnCheckBoxchkRadioButtonrdoCheckBoxListchklstRadioButtonListrdolstListBoxlstDropDownListddlDataGridd
13、gDataListdlImageimgTabletblPanelpnlLinkButtonlnkbtnImageButtonimgbtnCalendercldAdRotatorarRequiredFieldValidatorrfvCompareValidatorcvRangeValidatorrvRegularExpressionValidatorrevValidatorSummaryvsCrystalReportViewerrptvew2、注释规范2.1、文件头部注释 在代码文件的头部进行注释，标注出创建人、创建时间、修改人、修改时间、修改内容、代码的功能，这在团队开发中必不可少，它们可以使后来维护/修改的同伴在遇到问题时，在第一时间知道他应该向谁去寻求帮助，并且知道这个文件经历了多少次迭代、经历了多少
