16、把相同或近乎相同的代码形成函数和宏
—————————————————————
有人说,最好的程序员,就是最喜欢“偷懒”的程序,其中不无道理。
如果你有一些程序的代码片段很相似,或直接就是一样的,请把他们放在一个函数中。
而如果这段代码不多,而且会被经常使用,你还想避免函数调用的开销,那么就把他写
成宏吧。
千万不要让同一份代码或是功能相似的代码在多个地方存在,不然如果功能一变,你就
要修改好几处地方,这种会给维护带来巨大的麻烦,所以,做到“一改百改”,还是要
形成函数或是宏。
17、表达式中的括号
—————————
如果一个比较复杂的表达式中,你并不是很清楚各个操作符的忧先级,即使是你很清楚
优先级,也请加上括号,不然,别人或是自己下一次读程序时,一不小心就看走眼理解
错了,为了避免这种“误解”,还有让自己的程序更为清淅,还是加上括号吧。
比如,对一个结构的成员取地址:
GetUserAge( &( UserInfo->age ) );
虽然,&UserInfo->age中,->操作符的优先级最高,但加上一个括号,会让人一眼就看
明白你的代码是什么意思。
再比如,一个很长的条件判断:
if ( ( ch[0] >= '0' || ch[0] <= '9' ) &&
( ch[1] >= 'a' || ch[1] <= 'z' ) &&
( ch[2] >= 'A' || ch[2] <= 'Z' ) )
括号,再加上空格和换行,你的代码是不是很容易读懂了?
18、函数参数中的const
———————————
对于一些函数中的指针参数,如果在函数中只读,请将其用const修饰,这样,别人一读
到你的函数接口时,就会知道你的意图是这个参数是[in],如果没有const时,参数表示
[in/out],注意函数接口中的const使用,利于程序的维护和避免犯一些错误。
虽然,const修饰的指针,如:const char* p,在C中一点用也没有,因为不管你的声明
是不是const,指针的内容照样能改,因为编译器会强制转换,但是加上这样一个说明,
有利于程序的阅读和编译。因为在C中,修改一个const指针所指向的内存时,会报一个W
arning。这会引起程序员的注意。
C++中对const定义的就很严格了,所以C++中要多多的使用const,const的成员函数,co
nst的变量,这样会对让你的代码和你的程序更加完整和易读。(关于C++的const我就不
多说了)
19、函数的参数个数(多了请用结构)
—————————————————
函数的参数个数最好不要太多,一般来说6个左右就可以了,众多的函数参数会让读代码
的人一眼看上去就很头昏,而且也不利于维护。如果参数众多,还请使用结构来传递参
数。这样做有利于数据的封装和程序的简洁性。
也利于使用函数的人,因为如果你的函数个数很多,比如12个,调用者很容易搞错参数
的顺序和个数,而使用结构struct来传递参数,就可以不管参数的顺序。
而且,函数很容易被修改,如果需要给函数增加参数,不需要更改函数接口,只需更改
结构体和函数内部处理,而对于调用函数的程序来说,这个动作是透明的。
20、函数的返回类型,不要省略
——————————————
我看到很多程序写函数时,在函数的返回类型方面不太注意。如果一个函数没有返回值
,也请在函数前面加上void的修饰。而有的程序员偷懒,在返回int的函数则什么不修饰
(因为如果不修饰,则默认返回int),这种习惯很不好,还是为了原代码的易读性,加
上int吧。
所以函数的返回值类型,请不要省略。
另外,对于void的函数,我们往往会忘了return,由于某些C/C++的编译器比较敏感,会
报一些警告,所以即使是void的函数,我们在内部最好也要加上return的语句,这有助
于代码的编译。
21、goto语句的使用
—————————
N年前,软件开发的一代宗师——迪杰斯特拉(Dijkstra)说过:“goto statment is
harmful !!”,并建议取消goto语句。因为goto语句不利于程序代码的维护性。
这里我也强烈建议不要使用goto语句,除非下面的这种情况:
#define FREE(p) if(p) { /
free(p); /
p = NULL; /
}
main()
{
char *fname, *lname, *mname;
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):(b)
即使是这样,也不这个宏也还是有Bug,因为如果我这样调用 MAX(i++, j++); , 经过
这个宏以后,i和j都被累加了两次,这绝不是我们想要的。
所以,在宏的使用上还是要谨慎考虑,因为宏展开是的结果是很难让人预料的。而且虽
然,宏的执行很快(因为没有函数调用的开销),但宏会让源代码澎涨,使目标文件尺
寸变大,(如:一个50行的宏,程序中有1000个地方用到,宏展开后会很不得了),相
反不能让程序执行得更快(因为执行文件变大,运行时系统换页频繁)。
因此,在决定是用函数,还是用宏时得要小心。
23、static的使用
————————
static关键字,表示了“静态”,一般来说,他会被经常用于变量和函数。一个static
的变量,其实就是全局变量,只不过他是有作用域的全局变量。比如一个函数中的stati
c变量:
char*
getConsumerName()
{
static int cnt = 0;
....
cnt++;
....
}
cnt变量的值会跟随着函数的调用次而递增,函数退出后,cnt的值还存在,只是cnt只能
在函数中才能被访问。而cnt的内存也只会在函数第一次被调用时才会被分配和初始化,
以后每次进入函数,都不为static分配了,而直接使用上一次的值。
对于一些被经常调用的函数内的常量,最好也声明成static(参见第12条)
但static的最多的用处却不在这里,其最大的作用的控制访问,在C中如果一个函数或是
一个全局变量被声明为static,那么,这个函数和这个全局变量,将只能在这个C文件中
被访问,如果别的C文件中调用这个C文件中的函数,或是使用其中的全局(用extern关
键字),将会发生链接时错误。这个特性可以用于数据和程序保密。
24、函数中的代码尺寸
——————————
一个函数完成一个具体的功能,一般来说,一个函数中的代码最好不要超过600行左右,
越少越好,最好的函数一般在100行以内,300行左右的孙函数就差不多了。有证据表明
,一个函数中的代码如果超过500行,就会有和别的函数相同或是相近的代码,也就是说
,就可以再写另一个函数。
另外,函数一般是完成一个特定的功能,千万忌讳在一个函数中做许多件不同的事。函
数的功能越单一越好,一方面有利于函数的易读性,另一方面更有利于代码的维护和重
用,功能越单一表示这个函数就越可能给更多的程序提供服务,也就是说共性就越多。
虽然函数的调用会有一定的开销,但比起软件后期维护来说,增加一些运行时的开销而
换来更好的可维护性和代码重用性,是很值得的一件事。
25、typedef的使用
—————————
typedef是一个给类型起别名的关键字。不要小看了它,它对于你代码的维护会有很好的
作用。比如C中没有bool,于是在一个软件中,一些程序员使用int,一些程序员使用sho
rt,会比较混乱,最好就是用一个typedef来定义,如:
typedef char bool;
一般来说,一个C的工程中一定要做一些这方面的工作,因为你会涉及到跨平台,不同的
平台会有不同的字长,所以利用预编译和typedef可以让你最有效的维护你的代码,如下
所示:
#ifdef SOLARIS2_5
typedef boolean_t BOOL_T;
#else
typedef int BOOL_T;
#endif
typedef short INT16_T;
typedef unsigned short UINT16_T;
typedef int INT32_T;
typedef unsigned int UINT32_T;
#ifdef WIN32
typedef _int64 INT64_T;
#else
typedef long long INT64_T;
#endif
typedef float FLOAT32_T;
typedef char* STRING_T;
typedef unsigned char BYTE_T;
typedef time_t TIME_T;
typedef INT32_T PID_T;
使用typedef的其它规范是,在结构和函数指针时,也最好用typedef,这也有利于程序
的易读和可维护性。如:
typedef struct _hostinfo {
HOSTID_T host;
INT32_T hostId;
STRING_T hostType;
STRING_T hostModel;
FLOAT32_T cpuFactor;
INT32_T numCPUs;
INT32_T nDisks;
INT32_T memory;
INT32_T swap;
} HostInfo;
typedef INT32_T (*RsrcReqHandler)(
void *info,
JobArray *jobs,
AllocInfo *allocInfo,
AllocList *allocList);
C++中这样也是很让人易读的:
typedef CArray<HostInfo, HostInfo&> HostInfoArray;
于是,当我们用其定义变量时,会显得十分易读。如:
HostInfo* phinfo;
RsrcReqHandler* pRsrcHand;
这种方式的易读性,在函数的参数中十分明显。
关键是在程序种使用typedef后,几乎所有的程序中的类型声明都显得那么简洁和清淅,
而且易于维护,这才是typedef的关键。
26、为常量声明宏
————————
最好不要在程序中出现数字式的“硬编码”,如:
int user[120];
为这个120声明一个宏吧。为所有出现在程序中的这样的常量都声明一个宏吧。比如Time
Out的时间,最大的用户数量,还有其它,只要是常量就应该声明成宏。如果,突然在程
序中出现下面一段代码,
for ( i=0; i<120; i++){
....
}
120是什么?为什么会是120?这种“硬编码”不仅让程序很读,而且也让程序很不好维
护,如果要改变这个数字,得同时对所有程序中这个120都要做修改,这对修改程序的人
来说是一个很大的痛苦。所以还是把常量声明成宏,这样,一改百改,而且也很利于程
序阅读。
#define MAX_USR_CNT 120
for ( i=0; i<MAX_USER_CNT; i++){
....
}
这样就很容易了解这段程序的意图了。
有的程序员喜欢为这种变量声明全局变量,其实,全局变量应该尽量的少用,全局变量
不利于封装,也不利于维护,而且对程序执行空间有一定的开销,一不小心就造成系统
换页,造成程序执行速度效率等问题。所以声明成宏,即可以免去全局变量的开销,也
会有速度上的优势。
27、不要为宏定义加分号
———————————
有许多程序员不知道在宏定义时是否要加分号,有时,他们以为宏是一条语句,应该要
加分号,这就错了。当你知道了宏的原理,你会赞同我为会么不要为宏定义加分号的。
看一个例子:
#define MAXNUM 1024;
这是一个有分号的宏,如果我们这样使用:
half = MAXNUM/2;
if ( num < MAXNUM )
等等,都会造成程序的编译错误,因为,当宏展开后,他会是这个样子的:
half = 1024;/2;
if ( num < 1024; )
是的,分号也被展进去了,所以造成了程序的错误。请相信我,有时候,一个分号会让
你的程序出现成百个错误。所以还是不要为宏加最后一个分号,哪怕是这样:
#define LINE "================================="
#define PRINT_LINE printf(LINE)
#define PRINT_NLINE(n) while ( n-- >0 ) { PRINT_LINE; }
都不要在最后加上分号,当我们在程序中使用时,为之加上分号,
main()
{
char *p = LINE;
PRINT_LINE;
}
这一点非常符合习惯,而且,如果忘加了分号,编译器给出的错误提示,也会让我们很
容易看懂的。
--
28、||和&&的语句执行顺序
————————————
条件语句中的这两个“与”和“或”操作符一定要小心,它们的表现可能和你想像的不
一样,这里条件语句中的有些行为需要和说一下:
express1 || express2
先执行表达式express1如果为“真”,express2将不被执行,express2仅在express
1为“假”时才被执行。因为第一个表达式为真了,整个表达式都为真,所以没有必要再
去执行第二个表达式了。
express1 && express2
先执行表达式express1如果为“假”,express2将不被执行,express2仅在express
1为“真”时才被执行。因为第一个表达式为假了,整个表达式都为假了,所以没有必要
再去执行第二个表达式了。
于是,他并不是你所想像的所有的表达式都会去执行,这点一定要明白,不然你的程序
会出现一些莫明的运行时错误。
例如,下面的程序:
if ( sum > 100 &&
( ( fp=fopen( filename,"a" ) ) != NULL ) {
fprintf(fp, "Warring: it beyond one hundred/n");
......
}
fprintf( fp, " sum is %id /n", sum );
fclose( fp );
本来的意图是,如果sum > 100 ,向文件中写一条出错信息,为了方便,把两个条件判
断写在一起,于是,如果sum<=100时,打开文件的操作将不会做,最后,fprintf和fclo
se就会发现未知的结果。
再比如,如果我想判断一个字符是不是有内容,我得判断这个字符串指针是不为空(NUL
L)并且其内容不能为空(Empty),一个是空指针,一个是空内容。我也许会这样写:
if ( ( p != NULL ) && ( strlen(p) != 0 ))
于是,如果p为NULL,那么strlen(p)就不会被执行,于是,strlen也就不会因为一个空
指针而“非法操作”或是一个“Core Dump”了。
记住一点,条件语句中,并非所有的语句都会执行,当你的条件语句非常多时,这点要
尤其注意。
29、尽量用for而不是while做循环
———————————————
基本上来说,for可以完成while的功能,我是建议尽量使用for语句,而不要使用while
语句,特别是当循环体很大时,for的优点一下就体现出来了。
因为在for中,循环的初始、结束条件、循环的推进,都在一起,一眼看上去就知道这是
一个什么样的循环。刚出学校的程序一般对于链接喜欢这样来:
p = pHead;
while ( p ){
...
...
p = p->next;
}
当while的语句块变大后,你的程序将很难读,用for就好得多:
for ( p=pHead; p; p=p->next ){
..
}
一眼就知道这个循环的开始条件,结束条件,和循环的推进。大约就能明白这个循环要
做个什么事?而且,程序维护进来很容易,不必像while一样,在一个编辑器中上上下下
的捣腾。
30、请sizeof类型而不是变量
—————————————
许多程序员在使用sizeof中,喜欢sizeof变量名,例如:
int score[100];
char filename[20];
struct UserInfo usr[100];
在sizeof这三个的变量名时,都会返回正确的结果,于是许多程序员就开始sizeof变量
名。这个习惯很虽然没有什么不好,但我还是建议sizeof类型。
我看到过这个的程序:
pScore = (int*) malloc( SUBJECT_CNT );
memset( pScore, 0, sizeof(pScore) );
...
此时,sizeof(pScore)返回的就是4(指针的长度),不会是整个数组,于是,memset就
不能对这块内存进行初始化。为了程序的易读和易维护,我强烈建议使用类型而不是变
量,如:
对于score: sizeof(int) * 100 /* 100个int */
对于filename: sizeof(char) * 20 /* 20个char */
对于usr: sizeof(struct UserInfo) * 100 /* 100个UserInfo */
这样的代码是不是很易读?一眼看上去就知道什么意思了。
另外一点,sizeof一般用于分配内存,这个特性特别在多维数组时,就能体现出其优点
了。如,给一个字符串数组分配内存,
/*
* 分配一个有20个字符串,
* 每个字符串长100的内存
*/
char* *p;
/*
* 错误的分配方法
*/
p = (char**)calloc( 20*100, sizeof(char) );
/*
* 正确的分配方法
*/
p = (char**) calloc ( 20, sizeof(char*) );
for ( i=0; i<20; i++){
p = (char*) calloc ( 100, sizeof(char) );
}
为了代码的易读,省去了一些判断,请注意这两种分配的方法,有本质上的差别。
31、不要忽略Warning
——————————
对于一些编译时的警告信息,请不要忽视它们。虽然,这些Warning不会妨碍目标代码的
生成,但这并不意味着你的程序就是好的。必竟,并不是编译成功的程序才是正确的,
编译成功只是万里长征的第一步,后面还有大风大浪在等着你。从编译程序开始,不但
要改正每个error,还要修正每个warning。这是一个有修养的程序员该做的事。
一般来说,一面的一些警告信息是常见的:
1)声明了未使用的变量。(虽然编译器不会编译这种变量,但还是把它从源程序中
注释或是删除吧)
2)使用了隐晦声明的函数。(也许这个函数在别的C文件中,编译时会出现这种警
告,你应该这使用之前使用extern关键字声明这个函数)
3)没有转换一个指针。(例如malloc返回的指针是void的,你没有把之转成你实际
类型而报警,还是手动的在之前明显的转换一下吧)
4)类型向下转换。(例如:float f = 2.0; 这种语句是会报警告的,编译会告诉
你正试图把一个double转成float,你正在阉割一个变量,你真的要这样做吗?还是在2.
0后面加个f吧,不然,2.0就是一个double,而不是float了)
不管怎么说,编译器的Warning不要小视,最好不要忽略,一个程序都做得出来,何况几
个小小的Warning呢?
32、书写Debug版和Release版的程序
————————————————
程序在开发过程中必然有许多程序员加的调试信息。我见过许多项目组,当程序开发结
束时,发动群众删除程序中的调试信息,何必呢?为什么不像VC++那样建立两个版本的
目标代码?一个是debug版本的,一个是Release版的。那些调试信息是那么的宝贵,在
日后的维护过程中也是很宝贵的东西,怎么能说删除就删除呢?
利用预编译技术吧,如下所示声明调试函数:
#ifdef DEBUG
void TRACE(char* fmt, ...)
{
......
}
#else
#define TRACE(char* fmt, ...)
#endif
于是,让所有的程序都用TRACE输出调试信息,只需要在在编译时加上一个参数“-DDEBU
G”,如:
cc -DDEBUG -o target target.c
于是,预编译器发现DEBUG变量被定义了,就会使用TRACE函数。而如果要发布给用户了
,那么只需要把取消“-DDEBUG”的参数,于是所有用到TRACE宏,这个宏什么都没有,
所以源程序中的所有TRACE语言全部被替换成了空。一举两得,一箭双雕,何乐而不为呢
?
顺便提一下,两个很有用的系统宏,一个是“__FILE__”,一个是“__LINE__”,分别
表示,所在的源文件和行号,当你调试信息或是输出错误时,可以使用这两个宏,让你
一眼就能看出你的错误,出现在哪个文件的第几行中。这对于用C/C++做的大工程非常的
管用。
-----------------------------------------------------------------------------
---
综上所述32条,都是为了三大目的——
1、程序代码的易读性。
2、程序代码的可维护性,
3、程序代码的稳定可靠性。
有修养的程序员,就应该要学会写出这样的代码!这是任何一个想做编程高手所必需面
对的细小的问题,编程高手不仅技术要强,基础要好,而且最重要的是要有“修养”!
好的软件产品绝不仅仅是技术,而更多的是整个软件的易维护和可靠性。
软件的维护有大量的工作量花在代码的维护上,软件的Upgrade,也有大量的工作花在代
码的组织上,所以好的代码,清淅的,易读的代码,将给大大减少软件的维护和升级成
本。
--注:本文转载自msdn.转载请注明.