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

命 名 规 范（试行） 通则： 1、在所有命名中，都应使用标准的英文单词或缩写。不得使用拼音或拼音缩写，除非该名字描述的是中文特有的内容，如半角、全角, 声母、韵母等。 2、所有命名都应遵循达意原则，即名称应含义清晰、明确。 3、所有命名都不易过长，应控制在规定的最大长度以内。 4、程序中不要出现仅靠大小写区分的相似的标识符。 例如： int x, X; // 变量x 与 X 容易混淆 void foo(int x); void FOO(float x); // 函数foo 与FOO容易混淆 5、程序中不要出现标识符完全相同的局部变量和全局变量，尽管两者的作用域不同而不会发生语法错误，但会使人误解 6、尽量避免名字中出现数字编号，如Value1,Value2等，除非逻辑上的确需要编号。 7、所有命名都应尽量使用全称。除去公认的缩写，如下表： 完整单词 缩写 完整单词 缩写 A ? M ? average avg manager mgr,mngr B ? message msg back bk O ? background bg Oracle Ora break brk P ? buffer buf panorama pano C ? password pwd color cr,clr picture pic control ctrl point pt D ? position pos data dat print prn delete del program prg document doc S ? E ? server srv edit edt source src error err statistic stat escape esc string str F ? Sybase Syb flag flg T ? form frm temp tmp G ? picture pic grid grd point pt I ? position pos increment inc print prn information info program prg initial init S ? insert ins server srv image img source src L ? statistic stat lable lab string str length len Sybase Syb list lst T ? library lib temp tmp 具体规范： 1、工程名： 不强制统一。 2、文件名： ·基于工程名，开头3个字母应表明与哪一个工程相关。 ·后面的字母应能够区别不同的功能。 ·不区分大小写。 ·长度不限于8.3格式，建议不多于30个字符。 ·若文件用于定义和实现类，建议文件名与类名保持一致。 3、函数名： ·函数名应清晰反映函数的功能、用途。 ·推荐使用动宾结构。全局函数的名字应当使用“动词”或者“动词＋名词”（动宾词组）。类的成员函数应当只使用“动词”，被省略掉的名词就是对象本身。 ·命名规则尽量与所采用的操作系统或开发工具的风格保持一致。例如Windows应用程序的标识符通常采用“大小写”混排的方式，如AddChild。 ·函数名最长不得超过30个字符。 ·函数名第一个字母必须大写。 ·全局函数必须以小写前缀g开头。 4、变量名： 原则上，变量名的命名遵从匈牙利记法。即：前缀 + 类型 + 变量名 1）格式： [m_|s_|g_] type [class name|struct name] variable name 2）解释： ·m_ ： 类的成员变量 ·ms_：类的静态成员变量 ·s_ ：静态全局变量 ·g_ ：普通全局变量 ·类型缩写（type） ·char, TCHAR： ch ·char[]，TCHAR[]： sz ·bool, BOOL： b ·int, __int16,__int32,__int64： n ·long： l ·double： d ·float： ft ·BYTE： by ·WORD： w ·DWORD： dw ·unsigned： u ·function： fn ·pointer：p 变量名最长不得超过20个字符。 5、类名： ·必须以大写C开头，后面字母反映具体含义，以清晰表达类的用途和功能为原则。 ·接口必须以大写I开头，代表 Interface 。 ·当名称由多个单词构成时，每一个单词的第一个字母必须大写。 其它约定：前缀 C 代表C++ 类名前缀 CF 代表COM 类工厂名前缀 CImpI 代表COM 接口实现的类名’） 前缀 CO 代表COM 对象名typedef