代码风格指导.doc

第一部分 命名规范 一、命名规则总览 据考察，没有一种命名规则可以让所有的程序员赞同： 有些程序员喜欢全部小写，有些程序员喜欢用下划线，所以如果要写一个my name的变量，他们常用的写法会有myname、my_name、MyName或者myName。 常见命名规则比较著名的命名规则首推匈牙利命名法，匈牙利命名法关键是：标识符的名字以一个或者多个小写字母开头作为前缀；前缀之后的是首字母大写的一个单词或多个单词组合，该单词要指明变量的用途。 int iI, iJ, ik; 前缀 i表示int类型 float fX, fY, fZ; 前缀 f表示float类型 lpszStr, 表示指向一个以\0结尾的字符串（sz）的长指针（lp）变量。 骆驼（Camel）命名法近年来越来越流行，在许多新的函数库和Java这样的平台下使用得当相多。骆驼命名法，正如它的名称所表示的那样，指的是混合使用大小写字母来构成标识符的名字。其中第一个单词首字母小写，余下的单词首字母大写。例如：printEmployeePaychecks()，函数名中每一个逻辑断点都有一个大写字母来标记。帕斯卡（Pascal）命名法与骆驼命名法类似。只不过骆驼命名法是第一个单词首字母小写，而帕斯卡命名法则是第一个单词首字母大写。例如：DisplayInfo()和UserName都是采用了帕斯卡命名法。另一种流行的命名规则称为下划线命名法。下划线法是随着C语言的出现流行起来的，在UNIX/LIUNX这样的环境，以及GNU代码中使用非常普遍。 1.标识符应当直观且可以拼读，可望文知意. 比如 sum,描述累加和 temp.描述临时变量。 单字符的名字也是常用的，如i, j, k等，它们通常可用作函数内的局部变量。 3.命名规则尽量与所采用的操作系统或开发工具的风格保持一致 比如 windows linux 4.程序中不要出现仅靠大小写区分的相似的标识符 int x, X; 5.程序中不要出现标识符完全相同的局部变量和全局变量，尽管两者的作用域不同而不会发生语法错误，但会使人误解。 6.变量的名字应当使用“名词”或者“形容词＋名词”。 7. 名字应当使用“动词”或者“动词＋名词” 比如 draw_box(); 8. 尽量避免名字中出现数字编号，如value1,value2等，除非逻辑上的确需要编号。 如果说value1代表新值，可用new_value 9. 用正确的反义词组命名具有互斥意义的变量或相反动作的函数等 比如：old_value ,new_value 三、Windows程序命名规则 1函数名用大写字母开头的单词组合而成 例如： void Draw(void); void SetValue(int value); 2变量和参数用小写字母开头的单词组合而成。 例如： int flag; int newValue; 3常量全用大写的字母，用下划线分割单词。 例如： const int MAX = 100; const int MAX_LENGTH = 100; 4静态变量加前缀s_（表示static）。 例如： void Init(…) { static int s_initValue; … } 5全局变量加前缀g_（表示global）。 例如： int g_howManyPeople; // 全局变量 int g_howMuchMoney; // 全局变量 四、linux 风格 （1）变量名必须有一定的意义，并且意义准确。例如有一个变量用于保存图书的数目，可以命名为number_of_book或者num_of_boo不建议使用i，因为它没有意义。也不建议使用number或book，因为意义不准确。 （2）不建议大小写混用。如定义一个计数变量，int nCount；这在Windows中是一个很好的变量名，其中nCount的首字母n用来说明这个变量的类型是int。但在Linux下不建议大小写混合使用，一般标识符只由小写字母，数字和下划线构成。 （3）的情况下，尽量使用较短的变量名。例如有一个变量，用于暂时存储一个计数值，把变量命名为tmp_count显然要比this_is_a_temperary_counter好。 （）函数名应该以动词开头，因为函数是一组具有特定功能的语句块。比如一个函数，它用于取得外部输入的数值，则可以命名为get_input_number。 第二部 分程序的版式 版式虽然不会影响程序的功能，但会影响可读性。程序的版式追求清晰、美观，是程序风格的重要构成因素。 一