偶然间在51cto上看到这样一篇文章,总结了几条程序员编写代码过程中的注意事项,其中几条对于我这个正式真正学习C语言的孩子来说还是需要特别注意一下,希望能够在接下来的日子里能够坚持学习代码编写,并编写出漂亮的代码。

1.标识符命名规则:

标识符应当直观且可以拼读,可望文知意,最好采用英文单词或其组合,便于记忆和阅读,切忌使用汉语拼音来命名。长名字能更好地表达含义,所以函数名、变量名、类名长达十几个字符不足为怪,例如:

  1. 好的命名 int student_age,teacher_age;     
  2. 坏的命名 int age1,age2;   

但名字是否越长越好呢?不是的,请看下面的例子:

  1. struct student     
  2.      {     
  3.           int student_age;    /* 坏的命名 */    
  4.           char *student_name;     
  5.      }     
  6. struct student     
  7.      {     
  8.           int age;               /* 好的命名 */    
  9.           char *name;     
  10.      }   

为什么前者不好呢,因为很多余,结构体的名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.运算符的优先级:

尽量采用加小括号来进行控制运算顺序,否则程序会很难阅读。

3.不要使用太复杂的表达式,尤其是嵌套时,一定要采用合适的分隔符分开。

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)都属于不良风格。

指针变量的零值是NULL。尽管NULL的值与0相同,但是两者意义不同。对于指针变量p ,它与零值比较的if语句如下:

  1. if (p == NULL)     
  2. if (p != NULL)   

而不要写成:

  1. if (p == 0// 容易让人误解p是整型变量     
  2. if (p != 0)     

5.多层if语句采用if else if结构,这样结构看起来比较清晰。

6.改善循环效率:

  1. for (i = 0; i < strlen(name); i++)    //效率明显差于下面的循环:     
  2. n = strlen(name);     
  3. for (i = 0; i < n; i++)   

7.少用goto语句,慎用goto语句,但不并不是禁用,因为goto语句可以从一大堆循环中跳出。

8.消除魔鬼数:

魔鬼数者,没名字的常数也,你若看英文资料,它们的说法是magic data,我们的一些作品将其翻译为“魔术数”,我更愿意将其翻译为“魔鬼数”,因为它是一个导致代码的可读性极差的“魔鬼”。

假使你在程序里写下下面的一段代码:

  1. for (i=0; i < 100; i++);for (i=0; i < 99; i++);   

谁都不知道100、99是个什么玩意,你可能意味着100是范围的边界(最大值),就应该给出定义,代码的读者才能明白你的意思:

  1. #define MAX 100 /* C语言的宏常量 */     
  2. const int MAX = 100// C++ 语言的const常量     
  3. for (i=0; i < MAX; i++);for (i=0; i < MAX-1; i++)的意思就很清楚了。   

并且如果某一常量与其它常量密切相关,应在定义中包含这种关系,而不应给出一些孤立的值。

9.函数名字与返回值类型在语义上不可冲突,C标准库函数getchar违反了这一规则。

getchar的原型返回值是int,但接受的是一个char类型的值。

10.避免产生野指针,解决方法一是:在指针变量创建时,要么置于NULL,要么给予其合适的空间。二是指针在free或者delete后将其赋值为NULL。如下:

  1. char *p = NULL;     
  2. char *str = (char *) malloc(100);    

以上是一些简单的在代码编写风格中的注意事项,其中6、8两条我之前还经常犯的错误,希望以后的日子里会更加注意代码编写风格。写出“漂亮美丽的代码”。

“写出漂亮美丽的代码”

发表评论

您的电子邮箱地址不会被公开。 必填项已用*标注

此站点使用Akismet来减少垃圾评论。了解我们如何处理您的评论数据