编程修养(5)(转载)

dragon_kai

16、把相同或近乎相同的代码形成函数和宏
—————————————————————
有人说，最好的程序员，就是最喜欢“偷懒”的程序，其中不无道理。
如果你有一些程序的代码片段很相似，或直接就是一样的，请把他们放在一个函数中。
而如果这段代码不多，而且会被经常使用，你还想避免函数调用的开销，那么就把他写
成宏吧。
千万不要让同一份代码或是功能相似的代码在多个地方存在，不然如果功能一变，你就
要修改好几处地方，这种会给维护带来巨大的麻烦，所以，做到“一改百改”，还是要
形成函数或是宏。
17、表达式中的括号
—————————
如果一个比较复杂的表达式中，你并不是很清楚各个操作符的忧先级，即使是你很清楚
优先级，也请加上括号，不然，别人或是自己下一次读程序时，一不小心就看走眼理解
错了，为了避免这种“误解”，还有让自己的程序更为清淅，还是加上括号吧。
比如，对一个结构的成员取地址：
GetUserAge( &( UserInfo->age ) );
虽然，&UserInfo->age中，->操作符的优先级最高，但加上一个括号，会让人一眼就看
明白你的代码是什么意思。
再比如，一个很长的条件判断：
if ( ( ch[0] >= &#39;0&#39; || ch[0] <= &#39;9&#39; ) &&
( ch[1] >= &#39;a&#39; || ch[1] <= &#39;z&#39; ) &&
( ch[2] >= &#39;A&#39; || ch[2] <= &#39;Z&#39; ) )
括号，再加上空格和换行，你的代码是不是很容易读懂了？
18、函数参数中的const
———————————
对于一些函数中的指针参数，如果在函数中只读，请将其用const修饰，这样，别人一读
到你的函数接口时，就会知道你的意图是这个参数是[in]，如果没有const时，参数表示
[in/out]，注意函数接口中的const使用，利于程序的维护和避免犯一些错误。
虽然，const修饰的指针，如：const char* p，在C中一点用也没有，因为不管你的声明
是不是const，指针的内容照样能改，因为编译器会强制转换，但是加上这样一个说明，
有利于程序的阅读和编译。因为在C中，修改一个const指针所指向的内存时，会报一个
Warning。这会引起程序员的注意。
C++中对const定义的就很严格了，所以C++中要多多的使用const，const的成员函数，c
onst的变量，这样会对让你的代码和你的程序更加完整和易读。（关于C++的const我就
不多说了）
19、函数的参数个数（多了请用结构）
—————————————————
函数的参数个数最好不要太多，一般来说6个左右就可以了，众多的函数参数会让读代码
的人一眼看上去就很头昏，而且也不利于维护。如果参数众多，还请使用结构来传递参
数。这样做有利于数据的封装和程序的简洁性。
也利于使用函数的人，因为如果你的函数个数很多，比如12个，调用者很容易搞错参数
的顺序和个数，而使用结构struct来传递参数，就可以不管参数的顺序。
而且，函数很容易被修改，如果需要给函数增加参数，不需要更改函数接口，只需更改
结构体和函数内部处理，而对于调用函数的程序来说，这个动作是透明的。
20、函数的返回类型，不要省略
——————————————
我看到很多程序写函数时，在函数的返回类型方面不太注意。如果一个函数没有返回值
，也请在函数前面加上void的修饰。而有的程序员偷懒，在返回int的函数则什么不修饰
（因为如果不修饰，则默认返回int），这种习惯很不好，还是为了原代码的易读性，加
上int吧。
所以函数的返回值类型，请不要省略。
另外，对于void的函数，我们往往会忘了return，由于某些C/C++的编译器比较敏感，会
报一些警告，所以即使是void的函数，我们在内部最好也要加上return的语句，这有助
于代码的编译。
21、goto语句的使用
—————————
N年前，软件开发的一代宗师——迪杰斯特拉(Dijkstra)说过：“goto statment is ha
rmful !!”，并建议取消goto语句。因为goto语句不利于程序代码的维护性。
这里我也强烈建议不要使用goto语句，除非下面的这种情况：
#define FREE(p) if(p) { \\
free(p); \\
p = NULL; \\
}
main()
{
char *fname=NULL, *lname=NULL, *mname=NULL;
fname = ( char* ) calloc ( 20, sizeof(char) );
if ( fname == NULL ){
goto ErrHandle;
}
lname = ( char* ) calloc ( 20, sizeof(char) );
if ( lname == NULL ){
goto ErrHandle;
}
mname = ( char* ) calloc ( 20, sizeof(char) );
if ( mname == NULL ){
goto ErrHandle;
}
......
ErrHandle:
FREE(fname);
FREE(lname);
FREE(mname);
ReportError(ERR_NO_MEMOEY);
}
也只有在这种情况下，goto语句会让你的程序更易读，更容易维护。（在用嵌C来对数据
库设置游标操作时，或是对数据库建立链接时，也会遇到这种结构）
22、宏的使用
——————
很多程序员不知道C中的“宏”到底是什么意思？特别是当宏有参数的时候，经常把宏和
函数混淆。我想在这里我还是先讲讲“宏”，宏只是一种定义，他定义了一个语句块，
当程序编译时，编译器首先要执行一个“替换”源程序的动作，把宏引用的地方替换成
宏定义的语句块，就像文本文件替换一样。这个动作术语叫“宏的展开”
使用宏是比较“危险”的，因为你不知道宏展开后会是什么一个样子。例如下面这个宏
：
#define MAX(a, b) a>b?a:b
当我们这样使用宏时，没有什么问题： MAX( num1, num2 ); 因为宏展开后变成 num1>
num2?num1:num2；。 但是，如果是这样调用的，MAX( 17+32, 25+21 ); 呢，编译时出
现错误，原因是，宏展开后变成：17+32>25+21?17+32:25+21，哇，这是什么啊？
所以，宏在使用时，参数一定要加上括号，上述的那个例子改成如下所示就能解决问题
了。
#define MAX( (a), (b) ) (a)>(b)?(a)Sadb)
即使是这样，也不这个宏也还是有Bug，因为如果我这样调用 MAX(i++, j++); ， 经过
这个宏以后，i和j都被累加了两次，这绝不是我们想要的。
所以，在宏的使用上还是要谨慎考虑，因为宏展开是的结果是很难让人预料的。而且虽
然，宏的执行很快（因为没有函数调用的开销），但宏会让源代码澎涨，使目标文件尺
寸变大，（如：一个50行的宏，程序中有1000个地方用到，宏展开后会很不得了），相
反不能让程序执行得更快（因为执行文件变大，运行时系统换页频繁）。
因此，在决定是用函数，还是用宏时得要小心

dragon_kai

16、把相同或近乎相同的代码形成函数和宏
—————————————————————
有人说，最好的程序员，就是最喜欢“偷懒”的程序，其中不无道理。
如果你有一些程序的代码片段很相似，或直接就是一样的，请把他们放在一个函数中。
而如果这段代码不多，而且会被经常使用，你还想避免函数调用的开销，那么就把他写
成宏吧。
千万不要让同一份代码或是功能相似的代码在多个地方存在，不然如果功能一变，你就
要修改好几处地方，这种会给维护带来巨大的麻烦，所以，做到“一改百改”，还是要
形成函数或是宏。
17、表达式中的括号
—————————
如果一个比较复杂的表达式中，你并不是很清楚各个操作符的忧先级，即使是你很清楚
优先级，也请加上括号，不然，别人或是自己下一次读程序时，一不小心就看走眼理解
错了，为了避免这种“误解”，还有让自己的程序更为清淅，还是加上括号吧。
比如，对一个结构的成员取地址：
GetUserAge( &( UserInfo->age ) );
虽然，&UserInfo->age中，->操作符的优先级最高，但加上一个括号，会让人一眼就看
明白你的代码是什么意思。
再比如，一个很长的条件判断：
if ( ( ch[0] >= &#39;0&#39; || ch[0] <= &#39;9&#39; ) &&
( ch[1] >= &#39;a&#39; || ch[1] <= &#39;z&#39; ) &&
( ch[2] >= &#39;A&#39; || ch[2] <= &#39;Z&#39; ) )
括号，再加上空格和换行，你的代码是不是很容易读懂了？
18、函数参数中的const
———————————
对于一些函数中的指针参数，如果在函数中只读，请将其用const修饰，这样，别人一读
到你的函数接口时，就会知道你的意图是这个参数是[in]，如果没有const时，参数表示
[in/out]，注意函数接口中的const使用，利于程序的维护和避免犯一些错误。
虽然，const修饰的指针，如：const char* p，在C中一点用也没有，因为不管你的声明
是不是const，指针的内容照样能改，因为编译器会强制转换，但是加上这样一个说明，
有利于程序的阅读和编译。因为在C中，修改一个const指针所指向的内存时，会报一个
Warning。这会引起程序员的注意。
C++中对const定义的就很严格了，所以C++中要多多的使用const，const的成员函数，c
onst的变量，这样会对让你的代码和你的程序更加完整和易读。（关于C++的const我就
不多说了）
19、函数的参数个数（多了请用结构）
—————————————————
函数的参数个数最好不要太多，一般来说6个左右就可以了，众多的函数参数会让读代码
的人一眼看上去就很头昏，而且也不利于维护。如果参数众多，还请使用结构来传递参
数。这样做有利于数据的封装和程序的简洁性。
也利于使用函数的人，因为如果你的函数个数很多，比如12个，调用者很容易搞错参数
的顺序和个数，而使用结构struct来传递参数，就可以不管参数的顺序。
而且，函数很容易被修改，如果需要给函数增加参数，不需要更改函数接口，只需更改
结构体和函数内部处理，而对于调用函数的程序来说，这个动作是透明的。
20、函数的返回类型，不要省略
——————————————
我看到很多程序写函数时，在函数的返回类型方面不太注意。如果一个函数没有返回值
，也请在函数前面加上void的修饰。而有的程序员偷懒，在返回int的函数则什么不修饰
（因为如果不修饰，则默认返回int），这种习惯很不好，还是为了原代码的易读性，加
上int吧。
所以函数的返回值类型，请不要省略。
另外，对于void的函数，我们往往会忘了return，由于某些C/C++的编译器比较敏感，会
报一些警告，所以即使是void的函数，我们在内部最好也要加上return的语句，这有助
于代码的编译。
21、goto语句的使用
—————————
N年前，软件开发的一代宗师——迪杰斯特拉(Dijkstra)说过：“goto statment is ha
rmful !!”，并建议取消goto语句。因为goto语句不利于程序代码的维护性。
这里我也强烈建议不要使用goto语句，除非下面的这种情况：
#define FREE(p) if(p) { \\
free(p); \\
p = NULL; \\
}
main()
{
char *fname=NULL, *lname=NULL, *mname=NULL;
fname = ( char* ) calloc ( 20, sizeof(char) );
if ( fname == NULL ){
goto ErrHandle;
}
lname = ( char* ) calloc ( 20, sizeof(char) );
if ( lname == NULL ){
goto ErrHandle;
}
mname = ( char* ) calloc ( 20, sizeof(char) );
if ( mname == NULL ){
goto ErrHandle;
}
......
ErrHandle:
FREE(fname);
FREE(lname);
FREE(mname);
ReportError(ERR_NO_MEMOEY);
}
也只有在这种情况下，goto语句会让你的程序更易读，更容易维护。（在用嵌C来对数据
库设置游标操作时，或是对数据库建立链接时，也会遇到这种结构）
22、宏的使用
——————
很多程序员不知道C中的“宏”到底是什么意思？特别是当宏有参数的时候，经常把宏和
函数混淆。我想在这里我还是先讲讲“宏”，宏只是一种定义，他定义了一个语句块，
当程序编译时，编译器首先要执行一个“替换”源程序的动作，把宏引用的地方替换成
宏定义的语句块，就像文本文件替换一样。这个动作术语叫“宏的展开”
使用宏是比较“危险”的，因为你不知道宏展开后会是什么一个样子。例如下面这个宏
：
#define MAX(a, b) a>b?a:b
当我们这样使用宏时，没有什么问题： MAX( num1, num2 ); 因为宏展开后变成 num1>
num2?num1:num2；。 但是，如果是这样调用的，MAX( 17+32, 25+21 ); 呢，编译时出
现错误，原因是，宏展开后变成：17+32>25+21?17+32:25+21，哇，这是什么啊？
所以，宏在使用时，参数一定要加上括号，上述的那个例子改成如下所示就能解决问题
了。
#define MAX( (a), (b) ) (a)>(b)?(a)Sadb)
即使是这样，也不这个宏也还是有Bug，因为如果我这样调用 MAX(i++, j++); ， 经过
这个宏以后，i和j都被累加了两次，这绝不是我们想要的。
所以，在宏的使用上还是要谨慎考虑，因为宏展开是的结果是很难让人预料的。而且虽
然，宏的执行很快（因为没有函数调用的开销），但宏会让源代码澎涨，使目标文件尺
寸变大，（如：一个50行的宏，程序中有1000个地方用到，宏展开后会很不得了），相
反不能让程序执行得更快（因为执行文件变大，运行时系统换页频繁）。
因此，在决定是用函数，还是用宏时得要小心