编码规范
时间:2011-03-05 来源:守候只为你
2.注释命名
2.1.模块(类)注释,类属性注释,方法注释的规则。如下:
开始必须以以下形式书写模块注释:
///<summary>
///<Properties depiction>
///</summary>
2.2代码间注释
代码间注释分为单行注释和多行注释:
//<单行注释>
/*多行注释1
多行注释2
多行注释3*/
代码中遇到语句块时必须添加注释(if,for,foreach,……),添加的注释必须能够说明此语句块的作用和实现手段(所用算法等等)。
3.控件命名
控件命名 = 控件名称前二到三个字母 + 名称,如Labl控件(labUserName)
命名方法: |
|||
主要控件名简写对照表: |
|||
控件名 |
简写 |
控件名 |
简写 |
Lable |
lbl |
TextBox |
txt |
Button |
btn |
LinkButton |
lnkbtn |
ImageButton |
imgbtn |
DropDownList |
ddl |
ListBox |
lst |
DataGrid |
dg |
DataList |
dl |
CheckBox |
chk |
CheckBoxList |
chkls |
RadioButton |
rdo |
RadioButtonList |
rdolt |
Image |
img |
Panel |
pnl |
Calender |
cld |
AdRotator |
ar |
Table |
tbl |
RequiredFieldValidator |
rfv |
CompareValidator |
cv |
RangeValidator |
rv |
RegularExpressionValidator |
rev |
ValidatorSummary |
vs |
CrystalReportViewer |
rptvew |
4. 变量(Variable)命名
程序中变量名称 = 变量的前缀 +代表变量含意的英文单词或单词缩写。
类模块级的变量请用“m_” +数据类型缩写作为前缀(其中,mØ 为“memory”缩写,数据类型缩写见附件中的《数据类型缩写表》)。
鉴于大多数名称都是通过连接若干单词构造的,请使用大小写混合的格式以简化它们的阅读。每个单词的第一个字母都是大写.
即使对于可能仅出现在几个代码行中的生存期很短的变量,仍然使用有意义的名称。仅对于短循环索引使用单字母变量名,如 i 或 j。
在变量名中使用互补对,如Ø min/max、begin/end 和 open/close。
5.常量命名
常量名也应当有一定的意义,格式为 NOUN 或 NOUN_VERB。常量名均为大写,字之间用下划线分隔。
例:
private const bool WEB_ENABLEPAGECACHE_DEFAULT = true;
注:
变量名和常量名最多可以包含 255 个字符,但是,超过 25 到 30 个字符的名称比较笨拙。此外,要想取一个有实际意义的名称,清楚地表达变量或常量的用途,25 或 30 个字符应当足够了。
6. 类(Class)命名
a) 名字应该能够标识事物的特性。
b) 名字尽量不使用缩写,除非它是众所周知的。
c) 名字可以有两个或三个单词组成,但通常不应多于三个。
d) 在名字中,所有单词第一个字母大写。例如 IsSuperUser,包含ID的,ID全部大写,如CustomerID。
e) 使用名词或名词短语命名类。
f) 少用缩写。
g) 不要使用下划线字符 (_)。
例: public class FileStream
public class Button
public class String
7. 接口(Interface)命名
和类命名规范相同,唯一区别是 接口在名字前加上“I”前缀
例:
interface IDBCommand;
interface IButton;
8. 方法(Method)命名
和类命名规范相同。
9. 命名空间(NameSpace)命名
和类命名规范相同。