1 / 6
文档名称:

编程命名规范.doc

格式:doc   大小:33KB   页数:6页
下载后只包含 1 个 DOC 格式的文档,没有任何的图纸或源代码,查看文件列表

如果您已付费下载过本站文档,您可以点这里二次下载

分享

预览

编程命名规范.doc

上传人:nracyx 2022/10/5 文件大小:33 KB

下载得到文件列表

编程命名规范.doc

相关文档

文档介绍

文档介绍:该【编程命名规范 】是由【nracyx】上传分享,文档一共【6】页,该文档可以免费在线阅读,需要了解更多关于【编程命名规范 】的内容,可以使用淘豆网的站内搜索功能,选择自己适合的文档,以下文字是截取该文章内的部分文字,如需要获得完整电子版,请下载此文档到您的设备,方便您编辑和打印。编





目录
1(精品文档请下载)
。1强迫性命名标准 1(精品文档请下载)
1(精品文档请下载)
1。2详细标准 1(精品文档请下载)
1。3检查原那么 2(精品文档请下载)
第1页(共2页)
第0页(共2页)
整体原那么
强迫性命名标准
同一性:在编写一个子模块或派生类的时候,要遵循其基类或整体模块的命名风格,保持命名风格在整个模块中的同一性.(精品文档请下载)
标识符组成:标识符采用英文单词或其组合,应当直观且可以拼读,使用注释的方式说明其含义。
防止在不同级别的作用域中重名:程序中不要出现名字完全一样的部分变量和全局变量,尽管两者的作用域不同而不会发生语法错误,但容易使人误解。(精品文档请下载)
防止名字中出现数字编号:尽量防止名字中出现数字编号,如Value1,Value2等,除非逻辑上确实需要编号。这是为了防止程序员偷懒,不肯为命名动脑筋而导致产生无意义的名字(因为用数字编号最省事).(精品文档请下载)
1。1。2建议性命名标准
最小化长度和最大化信息量原那么:在保持一个标识符意思明确的同时,应当尽量缩短其长度。
防止过于相似:不要出现仅靠大小写区分的相似的标识符,例如“i”和“I”,“function"和“Function"等等。(精品文档请下载)
正确命名具有互斥意义的标识符:用正确的反义词组命名具有互斥意义的标识符,如:”nMinValue"和”nMaxValue","GetName()”和"SetName()”等等.(精品文档请下载)
详细标准
(1)类和接口:类名都以大写字母“C"开头,代表Class。接口以大写"I"开头,代表Interface。后跟一个或多个单词,每个单词的首字母要大写。推荐用“名词"或“形容词+名词”的形式,例如:CAnalyzer,CFastVector等等.(精品文档请下载)
(2)函数:函数的名称由一个或多个单词组成,每个单词的首字母要大写,最长不得超过20个字符.
全局函数应当使用“动词”或者“动词+名词”(动宾词组)的形式,例如:GetName(),DrawBox()。
第1页(共2页)
第0页(共2页)
(精品文档请下载)
类成员函数应当只使用“动词”,:box-〉Draw()。私有成员和保护成员函数的开头应当加上一个下划线“_”以示区别。虚函数****惯以“Do”开头。(精品文档请下载)
回调和事件处理函数****惯以单词“On”开头。例如:OnTimer().
(3)变量:变量是程序中使用最多的标识符,变量名由“作用域前缀+下划线+类型前缀+变量名字"组成,例如:intg_iDrawMode。变量最长不得超过20个字符。(精品文档请下载)
作用域前缀标明一个变量的可见范围,“s”表示。全局变量以“g”“l"为前缀。类的成员变量以“m”表示。类的静态成员变量以“ms”表示。类的全局成员变量以“mg"表示,建议不要直接使用类的全局成员变量。(精品文档请下载)
类型前缀标明一个变量的类型,“b”表示。字符型变量以“c”表示。字符串变量以“s”表示。整型和位域变量以“n”“l”“f"(BYTE)以“by"表示。字(WORD)变量以“w”“g"表示。指针型变量以“p”表示。枚举型变量以“e"表示。构造体变量以“st”表示。对象句柄以“h”表示。类的实例以“i”表示。(精品文档请下载)
变量名字应当使用“名词”或者“形容词+名词”形式,一个或多个单词组成,每个单词的首字母要大写.
对于某些用处简单明了的部分变量(for、while),也可以使用简化的方式,如:i,j,k,x,y,z。(精品文档请下载)
(4)常量:由“类型前缀+常量名字”组成。常量名字由全大写字母组成,单词间通过下划线来界定,如:cDELIMITER,。(精品文档请下载)
(5)构造体、宏、枚举、结合体定义:全部大写字母组成,单词间通过下划线来界定,如STUDENT_INFO。(精品文档请下载)
(6)注释:注释的位置应和被描绘的代码相邻,可以放在代码的上方或右方,不可放在下方.
边写代码边注释,修改代码同时修改相应的注释,。
第2页(共2页)
第0页(共2页)
注释应当准确、易懂,。
当代码比较长,特别是有多重嵌套时,应当在一些段落的完毕处加注释,便于阅读。
检查原那么
1、对于强迫性命名标准,将采用抽样检查方案
关键模块代码抽样50%;
非关键模块代码抽样20%;
2、在抽样范围内发现错误超过两个,甲方停顿检查。要求承包方自行检查,并提交检查记录;