ASPNET编码规范Word下载.docx
《ASPNET编码规范Word下载.docx》由会员分享，可在线阅读，更多相关《ASPNET编码规范Word下载.docx（16页珍藏版）》请在冰豆网上搜索。
span>
必须同其关闭标记同时出现。
如
…<
….<
/font>
/p>
…..<
*不得出现交叉包含的语句，如：
1.3标记的属性赋值规范
对于接受属性的标记，属性值必须使用双引号或者单引号包围。
如:
bodybgcolor=”red”>
fontsize=’7’>
注意：
必须确保属性的赋值无警告或错误。
1.4标记的缩进规范
*最高一级的父标记采用左对齐顶格方式书写。
*下一级标记采用左对齐向右缩进一个Tab的方式书写
在下一级依此类推，分别左对齐相对于父标记向右缩进一个Tab的方式书写
*同一级标记的首字符上下必须对齐。
在进行代码缩进时，可使用VS2005及其以上版本的开发环境中的自动缩进功能。
2.客户端JavaScript规范
2.1变量命名规范
*常量以及全局变量名必须全部使用大写字母
*变量名首字母必须小写
*变量名必须使用其类型的所写字符串开始。
各种类型的所写字符串如下：
整型变量：
int
长整型变量：
lng
浮点型变量：
flt
双精度变量：
dbl
对象引用变量：
obj
字符串变量:
str
Date类型变量：
dtm
*变量名必须采用有意义的单词命名，如：
strUserName、lngArrayIndex
*变量名除首字母小写外，其他单词首字符必须大写
*如果变量名过长可以使用单词缩写，除了被广泛了解的单词缩写以外，所有使用单词所写的变量名必须在定义时给出注释,如：
varstrAdName//用于表示Administrator帐户的名称
varstrAdminName//不用给出注释，Admin被广泛了解
2.2变量使用规范
*变量使用前必须定义。
没有定义的变量禁止使用
*变量的使用尽量缩小到小的作用域。
如循环使用
for（varI=0;
I<
12;
I++）{
}
而不是：
varI;
for（I=0;
12,I++）{
2.3对象命名规范
各种页面对象如text输入框、按钮、下拉选择框在命名时必须使用以下对应前缀：
*text输入框:
txt
*button按钮：
btn
*select下拉选择框：
sel
*option项:
opt
*form表单：
frm
*frame框架：
fra
*hidden表单项：
hdn
*div标记：
div
*span标记:
spn
*对话框对象:
dlg
*窗口对象：
wnd
2.4函数以及子过程命名规范
*函数的命名采用Pascal命名格式，命名内容格式使用动词＋名词对的方式，且命名能够体现函数的功能
*函数命名的动词前缀必须是同函数功能相关的完整动词
如：
GetUserName，CreateNewUser，UpdateUserInfos
第三章动态文件编码规范
1、命名规范
1.1、类的命名规范
*类名使用Pascal命名法。
如：
publicclassHelloWorld{...}
*以Class声明的类，都必须以名词或名词短语命名，体现类的作用。
ClassIndicator
*当类只需有一个对象实例（全局对象，比如Application等），必须以Class结尾，如：
ClassScreenClass
ClassSystemClass
*当类只用于作为其他类的基类，根据情况，以Base结尾。
ClassIndicatorBase
1.2、变量命名规范
变量的基本命名规范：
●常量必须全部使用CONST_前缀。
●变量名首字母必须小写。
●变量名采用Camel命名法（除首字母小写外，其他单词首字符必须大写），命名格式：
数据类型缩写+名词对。
各种常见数据类型的缩写如下：
*整型变量：
*长整型变量：
*浮点型变量：
*双精度变量：
*对象引用变量：
*字符串变量:
*Date类型变量：
●变量名必须采用有意义的单词命名。
strUserName、lngArrayIndex
●当变量名过长时，可使用单词缩写。
但除了被广泛了解的单词缩写之外，所有缩写的变量名必须在定义的后面给出注释。
dimstrAdName‘用于表示Administrator帐户的名称
dimstrAdminName‘不用给出注释，Admin被广泛了解
类的成员变量的特有命名规范：
类的所有成员变量前加下划线“_”，以区别于函数参数和函数中的局部变量。
1.3、函数命名及使用规范
1.3.1、命名规范
*函数命名使用Pascal命名法。
第一个单词的首字母大写，后面每一个单词的首字母大写。
*函数命名格式：
动词＋一个或多个名词。
注意：
函数命名的动词前缀必须是同函数功能相关的完整动词。
并且，函数的命名必须能够体现函数的功能。
GetUserName（）,CreateNewUser,UpdateUserInfosFromDatabase（）
1.3.2、使用规则
*如果函数有传入参数，则必须在函数的头部判断参数的合法性，不合法则不继续操作，并给予响应的提示。
*尽量使用函数封装代码块
*连续代码块尽量不要超过50行。
最多不得超过70行
*尽量使用局部变量。
*如有涉及到全局的资源（如Connection），尽量作为函数的参数传入。
*所有在函数内部创建打开的资源，在退出函数前必须关闭释放。
sqldatareader
1.4、控件命名规范
建议是使用控件名简写作为前缀，并且简写的首字母小写，并且整个名字符合Camel规范。
控件命名格式：
控件名简写前缀+英文描述
英文描述中的单词首字母大写
主要控件名简写对照表
控件名
简写
Label
lbl
TextBox
txt
Button
btn
CheckBox
chk
RadioButton
rdo
CheckBoxList
chklst
RadioButtonList
rdolst
ListBox
lst
DropDownList
ddl
DataGrid
dg
DataList
dl
Image
img
Table
tbl
Panel
pnl
LinkButton
lnkbtn
ImageButton
imgbtn
Calender
cld
AdRotator
ar
RequiredFieldValidator
rfv
CompareValidator
cv
RangeValidator
rv
RegularExpressionValidator
rev
ValidatorSummary
vs
CrystalReportViewer
rptvew
2、注释规范
2.1、文件头部注释
在代码文件的头部进行注释，标注出创建人、创建时间、修改人、修改时间、修改内容、代码的功能，这在团队开发中必不可少，它们可以使后来维护/修改的同伴在遇到问题时，在第一时间知道他应该向谁去寻求帮助，并且知道这个文件经历了多少次迭代、经历了多少个程序员的手。
样本：
/********************************************************************************
**创建人：
Eunge
**创建时间：
2004-6-8
**修改人：
Koffer
**修改时间：
2004-12-9
**修改内容：
添加/修改/删除函数X（）
Ken
2005-01-29
添加/修改/删除函数Y（）
**描述：
**主要用于产品信息的资料录入，…
*********************************************************************************/
我们甚至可以在这段文件头注释中加入版权信息、文件名、版本信息等。
2.2、函数、属性、类等注释
请使用///三斜线注释，这种注释是基于XML的，不仅能导出XML制作帮助文档，而且在各个函数、属性、类等的使用中，编辑环境会自动带出注释，方便你的开发。
以protected，protectedInternal，public声明的定义注释请都以这样命名方法。
例如：
///<
summary>
///功能：
用于从ERP系统中捞出产品信息的类
///创建人：
**
///创建时间：
2009-2-14
///修改人：
///修改时间：
2009-2-15
///修改内容：
添加/修改/删除函数（变量）***：
/summary>
classProductTypeCollector
{
///<
///产品编号
privatestring_productId;
///产品名称
privatestring_productName;
…
///用于从ERP系统中捞出产品信息的类
publicvoidSaveProductInfos（）
…
}
///获取产品信息
paramname="
productId"
>
产品编号<
/param>
returns>
产品信息<
/returns>
publicstringGetProductInfos（stringproductId）
//1参数合法性检查
//2操作步骤2
//2.1操作步骤2.1
//2.m操作步骤2.m
//3操作步骤3
//n操作步骤n
}
2.3、程序流程及逻辑点注释
在我们认为逻辑性较强的地方加入注释，说明这段程序的逻辑是怎样的，以方便我们自己后来的理解以及其他人的理解，并且这样还可以在一定程度上排除BUG。
在注释中写明我们的逻辑思想，对照程序，判断程序是否符合我们的初衷，如果不是，则我们应该仔细思考修改的是注释还是程序了。
3、缩进规范
*代码排版采用左对齐的方式。
*相同级别的两行左侧对齐。
*不同级别的两行相差一个‘Tab’。
classUser
PublicstringGetUserName（）
return_userName;
4、异常处理规范
1、什么时候用Trycatch?
什么时候用Finally?
1）数据库操作
2）文件操作
2、不要“捕捉了异常却什么也不做“。
如果隐藏了一个异常，你将永远不知道异常到底发生了没有。
3、发生异常时，给出友好的消息给用户，但要精确记录错误的所有可能细节，包括发生的时间，和相关方法，类名等。
4、只捕捉特定的异常，而不是一般的异常。
好：
voidReadFromFile（stringfileName）
{
try{//readfromfile.}
catch（FileIOExceptionex）{
//logerror.//re-throwexceptiondependingonyourcase.
throw;
}
不好：
catch（Exceptionex）{
//Catchinggeneralexceptionisbad.
//wasafileerrororsomeothererror.
//Hereyouarehidinganexception.
//Inthiscasenoonewilleverknowthatanexceptionhappened.
return"
"
;
5、不必在所有方法中捕捉一般异常。
不管它，让程序崩溃。
这将帮助你在开发周期发现大多数的错误。
6、你可以用应用程序级（线程级）错误处理器处理所有一般的异常。
遇到”以外的一般性错误“时，此错误处理器应该捕捉异常，给用户提示消息，在应用程序关闭或用户选择”忽略并继续“之前记录错误信息。
7、不必每个方法都用try-catch。
当特定的异常可能发生时才使用。
比如，当你写文件时，处理异常FileIOException.
8、别写太大的try-catch模块。
如果需要，为每个执行的任务编写单独的try-catch模块。
这将帮你找出哪一段代码产生异常，并给用户发出特定的错误消息。
9、如果应用程序需要，可以编写自己的异常类。
自定义异常不应从基类SystemException派生，而要继承于IApplicationException。
5、Request、Session、Application使用规范
*所有需要放入Session、Application中的对象，必须采用有意义的英文名字。
除了被广泛了解的单词缩写以外，不得采用单词缩写。
Session（“cp”）=strCurrentUserIP‘不允许
Session（“CurrentUserIP”）=strCurrentUserIP
Session（“Pwd”）=strPwd‘允许，Pwd被广泛了解为密码
*所有需要用到的Request、Session、Application中的元素的代码中，必须在代码头部赋值给代码内声明的变量。
*如果获得Form中提交的内容，必须使用Request.Form（“itemName”）.
*如果获得QueryString中提交的内容，必须使用Request.QueryString（“itemName”），不得在代码中出现Request（“。
。
”）这样的引用方式
第四章文件命名规范
1．数据库命名规范
1.1、数据文件命名规范
命名格式：
系统所属单位+_+系统名称+_+文件类型。
系统所属单位为lztc，系统名称为netshop,则数据库文件命名为lztc_netshop_database.mdf，lztc_netshop_log.log。
文件名全部采用小写。
1.2、数据库表命名规范
若该数据库库中有多个系统，表命名格式：
Tab_+系统名称_+单词或多个单词。
系统名是开发系统的缩写，系统名称全部采用小写英文字符,如Tab_bbs_Title,Tab_bbs_ForumType。
若该数据库库中只含有一个系统，那么表命名格式：
Tab_+单词或多个单词。
单词选择能够概括表内容的一个或多个英文单词，如Tab_UserInfo,Tab_UserType。
关连表命名规则为Re_表A_表B。
Re是Relative的缩写，如：
Re_User_ArticleType,Re_User_FormType。
表名长度不能超过30个字符，表名中含有的单词全部采用单数形式，单词首写字母要大写，多个单词间不用任何连接符号。
1.3、数据表字段命名规范
数据表字段命名格式：
表别名+_+单词
格式说明：
字段名全部采用小写英文单词，单词之间用”_”隔开。
user_name,user_pwd。
表别名规则：
如果表名是一个单词，别名就取单词的前4个字母；
如果表名是两个单词，就各取两个单词的前两个字母组成4个字母长的别名；
如果表的名字由3个单词组成，你不妨从头两个单词中各取一个然后从最后一个单词中再取出两个字母，结果还是组成4字母长的别名。
1.4、数据库视图命名规范
视图命名格式：
View_表A_表B_表C。
View表示视图。
这个视图由几个表产生就用”_”连接几个表的名，如果表过多可以将表名适当简化，但一定要列出所有表名。
1.5、存储过程命名规范
存储过程命名格式：
Proc_存取过程名_表名（缩写）。
比如：
Proc_User_Del，Proc_ArticleType_AddData。
1.6、SQL语句编写规范
SQL语句编写规则：
关键字必须大写，其他字段书写按上述命名规则。
SELECTuser_id,user_nameFROMTab_UserWHEREuser_id=‘tom’
2.文件夹及文件命名规范
文件夹命名一般采用英文，长度一般不超过20个字符，命名采用小写字母。
除特殊情况才使用中文拼音，一些常见的文件夹命名如：
images（存放图形文件），flash（存放Flash文件），style（存放CSS文件），scripts（存放Javascript脚本），inc（存放include文件），link（存放友情链接）,media（存放多媒体文件）等。
文件命名统一用小写的英文字母、数字和下划线的组合。
命名原则的指导思想一是使得你自己和工作组的每一个成员能够方便的理解每一个文件的意义，二是当我们在文件夹中使用“按名称排例”的命令时，同一种大类的文件能够排列在一起，以便我们查找、修改、替换、计算负载量等等操作。
2.1图片的命名原则
格式：
前缀_单词对
前缀表示此图片的大类性质，例如广告、标志、菜单、按钮等。
单词对说明此图片的使用位置。
说明：
✧放置在页面顶部的广告、装饰图案等长方形的图片取名：
banner
✧标志性的图片取名为：
logo
✧在页面上位置不固定并且带有链接的小图片我们取名为button
✧在页面上位置固定并且不带有链接的背景图片我们取名为backimg
✧在页面上某一个位置连续出现，性质相同的链接栏目的图片我们取名：
menu
✧装饰用的照片我们取名：
pic
✧不带链接表示标题的图片我们取名：
title
范例：
banner_sohu.gif、banner_sina.gif、menu_aboutus.gif、menu_job.gif、title_news.gif、logo_police.gif、logo_national.gif、pic_people.jpg、backimg_notes。
2.2动态语言文件命名规则
性质_描述
描述可以有多个单词，用”_”隔开。
性质一般是该页面的概要。
register_form.asp，register_post.asp，topic_lock.asp
第五章良好的编程习惯
好的行为形成好的习惯，好的习惯养成好的性格，好的性格编织好的命运。
遵守良好的编程习惯，写出成功的好程序。
1、避免使用大文件
如果一个文件里的代码超过300～400行，必须考虑将代码分开到不同类中。
2、避免写太长的方法
一个典型的方法代码在1～25行之间。
如果一个方法发代码超过25行，应该考虑将其分解为不同的方法。
3、方法名需能看出它作什么
别使用会引起误解的名字。
如果名字一目了然，就无需用文档来解释方法的功能了。
voidSavePhoneNumber（stringphoneNumber）{//Savethephonenumber.}
1.//Thismethodwillsavethephonenumber.
2.voidSaveData（stringphoneNumber）{//Savethephonenumber.}
4、一个方法只完成一个任务
不要把多个任务组合到一个方法中，即使那些任务非常小。
5、使用C#或VB.NET的特有类型
而不是System命名空间中定义的别名类型。
（为什么）
intage;
stringname;
objectcontactInfo;
Int16age;
Stringname;
ObjectcontactInfo;
6、别在程序中使用固定数值
用常量代替。
7、别用字符串常数
用资源文件。
8、必要时使用enum
别用数字或字符串来指示离散值。
enumMailType{Html,PlainText,Attachment}
voidSendMail（stringmessage,MailTypemailType）
{
switch（mailType）
caseMailType.Html:
//Dosomething
break;
caseMailType.PlainText:
c
升级会员 