文档介绍：编码风格标准
总则:
制定编码风格标准(以下称标准)是建立一套使编写的代码更清晰,便于阅读和修改,并且标准要容易遵守,易于检查。
所有编写项目代码的人员必须无条件遵守,如果代码不符合标准,按有关规定处罚。
如果对标准有建议,向项目主管和技术主管提出,详细说明使用原因、执行方法,经全体程序员同意,方能修改、删除或增加。
对标准有歧义的地方,需修改标准,消除歧义,修改过程同第3点要求。
标准以手册方式发布,保证程序员人手一本。
命名标准
Class
Class命名规则:[作用类型][类具体名称]
作用类型——三个小写字母:
窗体:frm
控件:ctl
接口:inf
一般用途:cls
具体名称:起有意义、与Class内容相关的英文名字,每个有意义的单词首字大写
Method
Method命名:[方法范围] [返回值类型][方法具体名称](参数类型 p_ [参数类型] [参数具体名称])
方法范围:
Class实例方法:m_
Class静态方法:s_
接口方法:i_
返回值类型——三个小写字母:
void:mth
类型缩写定义查看附录A
方法具体名称:起有意义、与Class内容相关的英文名字,每个有意义的单词首字大写
如果返回值是数组,在名称后加Arr
参数类型——三个小写字母,类型缩写定义查看附录
参数具体名称:起有意义、与Class内容相关的英文名字,每个有意义的单词首字大写
如果参数是数组,在名称后加Arr
Class内部使用的Method,必须使用private修饰符
例子:
public string [] m_strGetIDByNameArr(string p_strName)
public static void s_mthDo(string [] strWorkArr)
Field
Field命名:[变量范围] [变量类型][变量具体名称]
变量范围:
Class实例成员:m_
Class静态成员:s_
变量类型——三个小写字母,类型缩写定义查看附录
方法内部的变量不需要变量范围,但必须以变量类型开始。如果是for循环中的变量,至少要以i1,j2,k3….命名。
变量具体名称:起有意义、与Class内容相关的英文名字,每个有意义的单词首字大写。
如果变量是数组,在名称后加Arr
Class变量必须是private,对变量的读取和设置,使用Method进行。
例子:
private string [] m_strNameArr;
pirvate static bool s_blnOpened;
for(int i1=0;i1<10;i1++){
fro(int j2=0;j2<10;j2++){
}
}
特殊:如果Class只是用做数据的封装传递(没有方法,所有变量都是实例变量),变量都必须是public
Property
Property命名:[Property范围][Property类型][Property名称]
Property范围:
Class实例成员:m_
Class静态成员:s_
c、Property类型:三个字母,首字母大写,其它字母小写,类型缩写定义查看附录
d、Property名称:起有意义、与Class内容相