12-通用命名约定
2.4.3 通用命名约定
约定的是如何选择最适当的名称,这些准则适用于所有标识符的命名。
1.选择名称
(1)请选择易读的英文名称。例如,英文 Order的意思为规则、次序、订购等,如果用在排序列中就不是很合适,用来表示订单则更具可读性。可读性比详细描述更重要,比如表示坐标名称的ScreenX就比ScreenHorizontally 更具可读性。
(2)除下画线外,不要使用连字符或任何其他非字母数字字符。在数据库表字段名称设计时,与其他表字段有关联时,适当地使用表名+下横线+字段名,可以更清晰地表现出该字段与关联表对应字段的关系。比如产品分类表ProductClass中有字段Id与Name,那么产品表绑定的这两个字段可命名为ProductClass_Id与ProductClass_Name,这样在查看产品表时就可以清晰地知道这两个字段与分类表的关系。
(3)避免使用与常用编程语言的关键字冲突的标识符。
(4)变量和方法参数使用Camel 风格。例如,
01 string productName="";
02 int number=0;
03 string sqlString="";
04 double averageScore=0.0;
05 Users users=newUsers();
06 Users model=newUsers();
07 Users userModel=newUsers();
08 const string const_String = "";
09 Private stringGetProductName(int id)
10 {
11 return"";
12 }
(5)不要使用成员属性作为成员变量的前缀(其他变量命名也一样)。例如, 不要像Users m_users;这样定义成员变量,可以使用第(4)点的设置。
2.字母缩写词
(1)通常不要使用缩写。
(2)除非这种缩写已被广泛接受,或者团队当中大家都认可一种缩写。例如,使用 OnButtonClick,如果团队中普遍认可OnBtnClick这种写法也是可以的。