改善编码风格
2008-01-05 20:05:23 来源:WEB开发网核心提示:应该说,我们中的许多人,改善编码风格,编程的历史并不短,但很多时候,尽管NULL的值与0相同,但是两者意义不同,我们对自己编写出来的代码却毫无自信,有时候自己见了都怕
应该说,我们中的许多人,编程的历史并不短,但很多时候,我们对自己编写出来的代码却毫无自信,有时候自己见了都怕,尽管这段代码实现了要求的功能。
归其原因,往往是代码风格差导致的代码凌乱没有美感,本文的目的就是要讲解一般的良好风格,帮助读者写出“漂亮”的代码,事先要说明的是文中所涉及到的语言有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;
max = b;
max = c;
上面的if的执行语句只有一行也加了,是因为遵循了“不论if、for、while的执行语句
有多少都要加”的规则,这样可以防止书写失误,
当这样的语句层层嵌套的时候你就会知道这样做的好处。
4)各种数据类型与零值比较
在JAVA中,对于布尔变量flag,与零值(注重:不是0)比较的方式自然是if (flag
应当将整型变量用“==”或“!=”直接与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)
…
…
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;
max = b;
max = c;
上面的if的执行语句只有一行也加了,是因为遵循了“不论if、for、while的执行语句
有多少都要加”的规则,这样可以防止书写失误,
当这样的语句层层嵌套的时候你就会知道这样做的好处。
在JAVA中,对于布尔变量flag,与零值(注重:不是0)比较的方式自然是if (flag
应当将整型变量用“==”或“!=”直接与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)
…
…
赞助商链接