文档介绍:1 / 31
编码及命名规范
整理人:陈春祥
日 期:2011-01-04
适用范围
本文档适用人员范围:开发人员。
本文档适用开发范围:C#开发、JAVA开发。
注:本文档为使用进行开发的程序员提供编码规范的指导,其提的第一个字母大写)
2.6 枚举命名规则
Enum 类型和值名称使用全字母大写样式。
。
6 / 31
Enum类型名称上使用 Enum 后缀。
1.静态常量使用名词及名词短语
,名称应该明确表达参数的意义及类型,优先满足参数的意义描述
。
公有成员使用首字母大写样式
私有成员使用首字母小写样式
内部成员使用首字母小写样式
静态变量使用全字母大写样式
TextBox类:前缀txt+名称(首字母小写),如:txtCustomerName;
7 / 31
Label类:前缀lbl+名称(首字母小写),如:lblCustomerName;
Select类:前缀sel+名称(首字母小写),如:selCustomerType;
Radio类:前缀rdo+名称(首字母小写),如:rdoSubscribe;
CheckBox类:前缀chk+名称(首字母小写),如:chkTV
DataGrid类:前缀grd+名称(首字母小写),如grdCustomerList
Button类:前缀btn+名称(首字母小写),如:btnSubmit
Form类:前缀form+名称(Pascal规则),如:formLogin
2.9 变量命名
, j, k, l, m,
 属性命名
8 / 31
(is)作为前缀,不要使用Flag后缀,例如应该使用IsDeleted,而不要使用DeleteFlag
 方法命名
。例如,将动词置于前面时,所使用的名称诸如 InsertWidget 和 InsertSprocket;将宾语置于前面时,所使用的名称诸如 WidgetInsert 和 SprocketInsert。
.例如Save,SaveCustomer,而不要使用CustomerSave
 。例如,如果某个类已命名为 Book,则不要将某个方法称为 Book.CloseBook,而可以将方法命名为 Book.Close。
2.12 集合命名
9 / 31
“Collection”
 事件命名
1.event handlers命名使用EventHandler 后缀.
及e
后缀
5.事件命名使用语法时态反映其激发的状态,例如 Changed,Changing
5.考虑使用动词命名.
2.14实体命名
.
2.实体成员名称要加前缀,例如int前缀是n,string前缀是ch。使用首字母大写样式
如:public struct DEVICE_ROUTE_INFO
{
11 / 31
//设备ID
public int nDeviceID;
//接口ID
public int nInterfaceID;
//端口索引
public int nInterfaceIndex;
}
 项目名称
1、项目名称前缀要统一。例如所有备案系统的程序都用PRM做前缀,则以后增加任何程序代码,都需要以PRM这个作为前缀做项目的名称。
2、项目名称必须使用英文描述,要求英文字母不超过12个字母,并且使用英文单词不可超过2个单词。还要要求命名词要达意,一目了然。
11 / 31
如果名称使用英文单词太多则可以把前面几个单词简写,即使用单词首个字母即可。但是必须达到词要达意的原则。
 命名空间
写代码定义的任何类