软件工程命名规范(试行).doc

命 名 规 范（试行）通则：1、在所有命名中，都应使用标准的英文单词或缩写。不得使用拼音或拼音缩写，除非该名字描述的是中文特有的内容，如半角、全角, 声母、韵母等。2、所有命名都应遵循达意原则，即名称应含义清晰、明确。3、所有命名都不易过长，应控制在规定的最大长度以内。4、程序中不要出现仅靠大小写区分的相似的标识符。例如： int x, X; / 变量x 与 X 容易混淆void foo(int x); void FOO(float x); / 函数foo 与FOO容易混淆5、程序中不要出现标识符完全相同的局部变量和全局变量，尽管两者的作用域不同而不会发生语法错误，但会使人误解6、尽量避免名字中出现数字编号，如Value1,Value2等，除非逻辑上的确需要编号。7、所有命名都应尽量使用全称。除去公认的缩写，如下表：完整单词缩写完整单词缩写AMaverageavgmanagermgr,mngrBmessagemsgbackbkObackgroundbgOracleOrabreakbrkPbufferbufpanoramapanoCpasswordpwdcolorcr,clrpicturepiccontrolctrlpointptDpositionposdatadatprintprndeletedelprogramprgdocumentdocSEserversrveditedtsourcesrcerrorerrstatisticstatescapeescstringstrFSybaseSybflagflgTformfrmtemptmpGpicturepicgridgrdpointptIpositionposincrementincprintprninformationinfoprogramprginitialinitSinsertinsserversrvimageimgsourcesrcLstatisticstatlablelabstringstrlengthlenSybaseSyblistlstTlibrarylibtemptmp具体规范：1、工程名：不强制统一。2、文件名：基于工程名，开头3个字母应表明与哪一个工程相关。后面的字母应能够区别不同的功能。不区分大小写。长度不限于8.3格式，建议不多于30个字符。若文件用于定义和实现类，建议文件名与类名保持一致。3、函数名：函数名应清晰反映函数的功能、用途。推荐使用动宾结构。全局函数的名字应当使用“动词”或者“动词名词”（动宾词组）。类的成员函数应当只使用“动词”，被省略掉的名词就是对象本身。命名规则尽量与所采用的操作系统或开发工具的风格保持一致。例如Windows应用程序的标识符通常采用“大小写”混排的方式，如AddChild。函数名最长不得超过30个字符。函数名第一个字母必须大写。全局函数必须以小写前缀g开头。4、变量名：原则上，变量名的命名遵从匈牙利记法。即：前缀 + 类型 + 变量名1）格式：m_|s_|g_ type class name|struct name variable name2）解释：m_ ： 类的成员变量ms_：类的静态成员变量s_ ：静态全局变量g_ ：普通全局变量类型缩写（type）char, TCHAR： chchar，TCHAR： szbool, BOOL： bint, _int16,_int32,_int64： nlong： ldouble： dfloat： ftBYTE： byWORD： wDWORD： dwunsigned： u function： fnpointer：p变量名最长不得超过20个字符。5、类名：必须以大写C开头，后面字母反映具体含义，以清晰表达类的用途和功能为原则。接口必须以大写I开头，代表 Interface 。当名称由多个单词构成时，每一个单词的第一个字母必须大写。其它约定：前缀 C 代表C+ 类名。前缀 CF 代表COM 类工厂名。前缀 CImpI 代表COM 接口实现的类名。（在C+中默认前缀是C）前缀 CO 代表COM 对象名。6、结构名、宏名、枚举名、联合名：全部大写。枚举名加小写前缀enum。例：typedef enum _KFILE_OPEN_MODEenumOPEN_READONLY = 0,enumOPEN_READWRITE = 1,enumCREATE_ALWAY = 3 KFILE_OPEN_MODE;宏名加小写前缀def。例：#define defMAXNUMBER 100结构名加小写前缀tag，之后必须以大写K开头。例：typedef struct tagKPOINTint x;int y; KPOINT;联合名加小写前缀uni。例：typedef union _VARIANTchar unichVal;int uninVal;long unilVal;float uniftVal;. VARIANT;VC+源代码书写规范1. 在.h/.cpp的开头应有一段格式统一的说明（见引用一），内容包括：a. 文件名 (FileName)；b. 创建人 (Creater)；c. 文件创建时间 (Date)；d. 简短说明文件功能、用途 (Comment)。2. 除非极其简单，否则对函数应有注释说明（见引用二和引用三）。内容包括：功能、入口、出口参数，必要时还可有备注或补充说明。3. 每行代码的长度推荐为80列，最长不得超过120列；折行以对齐为准。例：HANDLE KSOpenFile(const char cszFileName,int nMode);或者：BOOL KSReadFile(HANDLE hFile,void *pvBuffer,int nReadSize,int *pnReadSize);4. 循环、分支代码，判断条件与执行代码不得在同一行上。例：正确：if (n = -2)n = 1;elsen = 2;不得写做：if (n = -2) n = 1;else n = 2;5. 指针的定义，* 号既可以紧接类型，也可以在变量名之前。（推荐后者）例：可写做：int* pnsize;也可写做：int *pnsize;但不得写做：int * pnsize;6. 在类的成员函数内调用非成员函数时，在非成员函数名前必须加上“:”。7. 函数入口参数有缺省值时，应注释说明。例:BOOL KSSaveToFile(const char cszFileName,BOOL bCanReplace /* = TRUE */);或者：BOOL KSSaveToFile(const char cszFileName,BOOL bCanReplace / = TRUE);8. else if 必须写在一行。9. 与、有关的各项规定：9.1、应独占一行。在该行内可有注释。例：正确：for (i = 0; i cbLine; i+) / .printf(Line %d:, i);printf(%sn, pFileLinesi);不得写做：for (i = 0; i 0)m = 1;n+;不得写做：if (i 0) m = 1;n+;例外：if (i = 0) ASSERT(FALSE); return; 9.3 在循环、分支之后若只有一行代码，虽然可省略、，但不推荐这么做。若省略后可能引起歧义，则必须加上、。例：正确：if (n = -2) n = 1; else if (n != nTemp) n = 2; else n = 3; 不得写做：if (n = -2)n = 1;else if (n != nTemp)n = 2;elsen = 3;不推荐：if (i 1) n = 3; 10. 与空格有关的各项规定。10.1 在所有两目、三目运算符的两边都必须有空格。在单目运算符两端不必空格。但在-、:、.、等运算符前后，及&（取地址）、*（取值）等运算符之后不得有空格。例：正确：int n = 0, nTemp;for (int i = nMinLine; i = nMaxLine; i+)不得写做：int n=0, nTemp;for ( int i=nMinLine; i=nMaxLine; i+ )10.2 for、while、if 等关键词之后应有1个空格，再接(，之后无空格；在结尾的)前不得有空格。例：正确：if (-2 = n)不得写做：if(-2 = n)或if ( -2 = n )等等。10.3 调用函数、宏时，(、)前后不得有空格。例：正确：printf(%dn, nIndex);不得写做：printf (%dn, nIndex);printf( %dn, nIndex );等等。10.4 类型强制转换时，()前后不得有空格例：可写做：(KSFile*)pFile;也可写做：(KSFile *)pFile不得写做：( KSFile* )pFile( KSFile * ) pFile11. 与缩进有关的各项规定11.1 缩进以 Tab 为单位。1 个 Tab 为 4 个空格11.2 下列情况，代码缩进一个 Tab:1. 函数体相对函数名及、。例：int Power(int x)Return (x * x);2. if、else、for、while、do 等之后的代码。3. 一行之内写不下，折行之后的代码，应在合理的位置进行折行。若有 + - * / 等运算符，则运算符应在上一行末尾，而不应在下一行的行首。11.3 下列情况，不必缩进：switch 之后的 case、default。例：switch (nID)case ID_PLAY:.break;case ID_STOP:.break;default:.break; 引用一: 文件开头的注释模板/* 文件名:* Copy