软件编码规范.pdf

命名规范
1、通则
1.1、在所有命名中，都应使用标准的英文单词或缩写，避免使用汉语拼音。
1.2、所有命名都应遵循达意原则，即名称应含义清晰、明确。
1.3、所有命名都不易过长，在可表达清晰的前提下越简洁越好。
1.4、所有命名都应尽量使用全称。
1.5、在类型名称特别复杂的时候，应使用typedef来定义别名。

2、标识符
2.1、标识符的命名要清晰、明了，有明确含义，同时使用完整的单词或大家基
本可以理解的缩写，避免使人产生误解。（较短的单词可通过去掉“元
音”形成缩写；较长的单词可取单词的头几个字母形成缩写；一些单词有
大家公认的缩写）
如下单词的常用缩写
applicationapplibrarylib
argumentargmanagermgr
averageavgmemorymem
blockblkmessagemsg
bufferbufobjectobj
commandcmdpasswordpwd
controlctrlpicturepic
databasedbploylinepline
deletedelpointerptr
descriptiondescpositionpos
dialogdlgrecordrec
dictionarydictreferenceref
dimensiondimresourcersc
distancedistscreenscr
documentdocserversrv
entityentsourcesrc
escapeescsystemsys
flagflgtemptmp
increaseinctexttxt
informationinfoversionver
lengthlenwindowwnd
VC++中常用控件缩写
AnimateaniProgressprg
CheckBoxchkPushButtonbtn
ComboBoxcmbRadioButtonrad
EditedtScrollBarsb
GroupBoxgrpSlidersld
ListBoxlstStaticstc
PicturepicTabControltab
2.2、长的标识符应使用缩写来缩短长度，而特短的标识符应该避免使用缩写。
更恰当：不恰当：
intiFlagintiFlg
HMODULEhLoadedSysRscHMODULEhLoadedSystemResource
变量和封装体命名中单词或缩写的第一个字母应大写，其它字母小写，单
词和单词之间直接连接，不得有其它字符。在宏定义中全部用大写，单词
与单词之间必须用下划线连接。
正确：错误：
TempResourceTemp_Resourcetemp_resource
#defineREG_KEYtempresource
#defineReg_Key
2.4、除了编译开关/头文件等特殊应用，应避免使用_EXAMPLE_TEST_之类以
下划线开始和结尾的定义。
2.5、对于变量命名，禁止取单个字符（如i、j、k...），命名除了要有具体含义
外，还能表明其变量类型、数据类型等，但i、j、k等作局部循环变量是
允许的。
2.6、命名时，如果需要进一步分类时，分类属性应放在前面。
正确：错误：
CListBoxm_wndLstFonts;CListBoxm_wndFontsLst;
CComboBoxm_wndCmbColors;CComboBoxm_wndColorsCmb;
2.7、命名中若使用特殊约定或缩写，则要有注释说明。（应该在源文件的开始
之处，对文件中所使用的缩写或约定，特别是特殊的缩写，进行必要的注
释说明）
2.8、在命名规范中没有规定到的地方，才可以使用自己特有的命名风格，要自
始至终保持一致，不可来回变化。
2.9、除非必要，不要用数字或较奇怪的字符来定义标识符。
正确：错误：
#defineEXAMPLE_TEST#defineEXAMPLE_0
TestLockDriverTest123
2.10、在同一软件产品内，应规划好接口部分标识符的命名，防止编译、链接
时产生冲突，可在普通标识基础上加上模块标识。
示例：
在TGRX模块中可定义为CTGRxObjectg_rxRegistry
在TGDB模块中可定义为CTGDbBlockRecordg_dbGlobal
在TGGui模块中可定义为CTGUiFrameWndg_uiCmdMgr
2.11、命名规范必须与所使用的系统风格保持一致，并在同一项目中统一，比
如有关STL的代码应使用STL中的全小写加下划线的风格，有关MFC的
代码则使用大小写混排的方式。

3、封装体
3.1、采用前缀和以大写开头的英文单词或缩写组成，即：前缀+标识符。
简写类型说明示例：
Cclass类