编程人员怎样才能写出美丽的代码(1)
编程人员怎样才能写出美丽的代码?本文将从以下10个方面讲述:
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语句来实现多分支选择。
- 上一篇:浅谈C/C++中的static和extern关键字
- 下一篇:C++中的指针用法总结