改善编码风格（超级简单实用）

改善编码风格（超级简单实用） 作者:系统  日期:2003-02-28  阅读:238

应该说，我们中的许多人，编程的历史并不短，但很多时候，我们对自己编写出来的代码却毫无自信，有时候自己见了都怕，尽管这段代码实现了要求的功能。归其原因，往往是代码风格差导致的代码凌乱没有美感，本文的目的就是要讲解一般的良好风格，帮助读者写出“美丽”的代码，事先要说明的是文中所涉及到的语言有C、C++、JAVA及BASIC，我之所以用了三种语言而不是只用一种语言是为了向读者表明风格对语言的通用的。       1）标识符（命名规则）     标识符应当直观且可以拼读，可望文知意，最好采用英文单词或其组合，便于记忆和阅读，切忌使用汉语拼音来命名。长名字能更好地表达含义，所以函数名、变量名、类名长达十几个字符不足为怪,例如：     好的命名  int student_age,teacher_age;     坏的命名  int age1,age2;     但名字是否越长越好呢？不是的，请看下面的例子：     struct student            {             int student_age;    /* 坏的命名 */             char *student_name;             }     struct student            {             int age;               /* 好的命名 */             char *name;             }     为什么前者不好呢，因为很多余，结构体的名student已经表达了student_age前面的 student的意思。     再比如字符串拷贝函数：void StringCopy(char *str1, char *str2);我们很难搞清 楚究竟是把str1拷贝到str2中，还是刚好倒过来。可   以把参数名字起得更有意义，如叫strSource和trDestination。这样从名字上就可以看出 应该把strSource拷贝到strDestination。     单字符的名字也是有用的，常见的如i,j,k,m,n,x,y,z等，它们通常可用作函数内的局 部变量。     2）运算符的优先级     如果代码行中的运算符比较多，应该用括号确定表达式的操作顺序，避免使用默认的 优先级。因为熟记各运算符的优先级是比较困难的，   就算你熟记并正确使用了，写出来的代码也容易产生歧义而使其可读性较差。      好的风格 if ((a | b) && (a & c))      坏的风格 if (a | b && a & c)      虽然后者和前者功能一样，但后者是很恐怖的，难以阅读。     3）不要编写太复杂的复合表达式。     复合表达式使用在适当的场合可以使代码更加简洁，但不能因为这个简洁而带来理解的复杂。 例如：   max = a > b ？(a > c ? a : c) : (b > c ? b : c)  // 复合表达式过于复杂 应该修改为：         max = a;         if(max < b)             {              max = b;             }         if(max < c)             {              max = c;             }   上面的if的执行语句只有一行也加了{}，是因为遵循了“不论if、for、while的执行语句 有多少都要加{}”的规则，这样可以防止书写失误，   当这样的语句层层嵌套的时候你就会知道这样做的好处。     4）各种数据类型与零值比较     在JAVA中，对于布尔变量flag，与零值（注意：不是0）比较的方式自然是if (flag == TRUE)或者if (flag == FALSE)，但是在C/C++中这却不是正确的选择。正确的选择应该是if (flag)或者if (！flag)，这是因为TRUE的值究竟是什么并没有统一的标准，例如Visual C++ 将TRUE定义为1，而Visual Basic则将TRUE定义为-1。if (flag == TRUE)、if (flag == 1 )、if(flag == FALSE)、if (flag == 0)都属于不良风格。     应当将整型变量用“==”或“！=”直接与0比较。  if (value == 0)         if (value != 0)         不可以写成         if (value)  // 会让人误解 value是布尔变量         if (!value)     指针变量的零值是NULL。尽管NULL的值与0相同，但是两者意义不同。对于指针变量p ，它与零值比较的if语句如下：   if (p == NULL)   if (p != NULL)     不要写成   if (p == 0)  // 容易让人误解p是整型变量   if (p != 0)       5）多层if语句     不要出现这样的结构：         if (condition1)            {              …              if (condition2)                 …                 if (condition3)                    …                     …             }      而应该代之以if-else-if结构：          if (condition1)            {              …             }          else  if (condition2)                {                   …                 }          else if (condition3)                 {                   …                 } …    这样的结构条理清楚，前者则容易导致写到后来自己都不知道写了些什么的事实。     可以用switch语句替换嵌套的if语句来实现多分支选择。        6）改善循环的效率         对于字符串name,看下面的循环：         for (i = 0; i < strlen(name); i++)效率明显差于下面的循环：         n = strlen(name);         for (i = 0; i < n; i++)         后者只要计算name的长度一次。      7）少用、慎用goto语句，并不禁用          goto语句能从多重循环体或者代码堆里一下子跳到外面， 例如：  { …   { …    { …     on error goto errorhandler;    }   }  }  errorhandler:  …        在Visual Basic中这一招是常用的。     8）消除魔鬼数     魔鬼数者，没名字的常数也，你若看英文资料，它们的说法是magic data，我们的一些作品将其翻译为“魔术数”，我更愿意将其翻译为“魔鬼数”，因为它是一个导致代码的可读性极差的“魔鬼”。     假使你在程序里写下下面的一段代码：     for (i=0; i < 100; i++);for (i=0; i < 99; i++);谁都不知道100、99是个什么玩 意，你可能意味着100是范围的边界（最大值），就应该给出定义，代码的读者才能明白你的意思：         #define      MAX   100  /*  C语言的宏常量  */         const int    MAX = 100;  //  C++ 语言的const常量     for (i=0; i < MAX; i++);for (i=0; i < MAX-1; i++)的意思就很清楚了。       并且如果某一常量与其它常量密切相关，应在定义中包含这种关系，而不应给出一些孤立的值。 例如： const  float   RADIUS = 100; const  float   DIAMETER = RADIUS * 2;     9）函数返回值    函数名字与返回值类型在语义上不可冲突,C标准库函数getchar违反了这一规则。    例如：    char c;    c = getchar();    if (c == EOF)    按照getchar名字的意思，将变量c声明为char类型是很自然的事情。但不幸的是getch ar的确不是char类型，而是int类型，其原型如下：   int getchar(void);    10)乱指一气的指针    “野指针”者，乱指一气的指针也，它不是NULL指针，是指向“垃圾”内存的指针。野 指针是很危险的，是经常导致bug的原因，它的成因主有两种：一是指针变量没有被初始化。在C/C++中任何指针变量刚被创建时不会自动成为NULL指针，它的缺省值是随机的。所以，指针变量在创建的同时应当被初始化，要么将指针设置为NULL，要么让它指向合法的内存。例如  char *p = NULL;  char *str = (char *) malloc(100);      二是指针p被free或者delete之后，没有置为NULL，让人误以为p是个合法的指针。       关于编码的风格，笔者还有许多需要讲解的，限于本文的篇幅，笔者暂时讲到这里，希望能对编程者有所帮助。