编程修养.txt

《编程修养》是一篇编程人员的基础注意事项指南

　　#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声明一个宏吧。为所有出现在程序中的这样的常量都声明一个宏吧。比如TimeOut的时间，最大的用户数量，还有其它，只要是常量就应该声明成宏。如果，突然在程序中出现下面一段代码， 
　　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仅在express1为“假”时才被执行。因为第一个表达式为真了，整个表达式都为真，所以没有必要再去执行第二个表达式了。 
　　express1 && express2 
　　先执行表达式express1如果为“假”，express2将不被执行，express2仅在express1为“真”时才被执行。因为第一个表达式为假了，整个表达式都为假了，所以没有必要再去执行第二个表达式了。 

于是，他并不是你所想像的所有的表达式都会去执行，这点一定要明白，不然你的程序会出现一些莫明的运行时错误。 
例如，下面的程序： 

　　if ( sum > 100 && 
　　　　 ( ( fp=fopen( filename,"a" ) ) != NULL )　 { 
　　　　 
　　　　 fprintf(fp, "Warring: it beyond one hundredn"); 
　　　　 ...... 
　　} 
　　 
　　fprintf( fp, " sum is %id n", sum ); 
　　fclose( fp ); 
本来的意图是，如果sum > 100 ，向文件中写一条出错信息，为了方便，把两个条件判断写在一起，于是，如果sum<=100时，打开文件的操作将不会做，最后，fprintf和fclose就会发现未知的结果。 
再比如，如果我想判断一个字符是不是有内容，我得判断这个字符串指针是不为空（NULL）并且其内容不能为空（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) );*/ 
　　p = (char*) calloc ( 100, sizeof(char) ); 
} 
（注：上述语句被注释掉的是原来的，是错误的，由dasherest朋友指正，谢谢） 
为了代码的易读，省去了一些判断，请注意这两种分配的方法，有本质上的差别。 

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输出调试信息，只需要在在编译时加上一个参数“-DDEBUG”，如： 
　　cc -DDEBUG -o target target.c 
于是，预编译器发现DEBUG变量被定义了，就会使用TRACE函数。而如果要发布给用户了，那么只需要把取消“-DDEBUG”的参数，于是所有用到TRACE宏，这个宏什么都没有，所以源程序中的所有TRACE语言全部被替换成了空。一举两得，一箭双雕，何乐而不为呢？ 
顺便提一下，两个很有用的系统宏，一个是“__FILE__”，一个是“__LINE__”，分别表示，所在的源文件和行号，当你调试信息或是输出错误时，可以使用这两个宏，让你一眼就能看出你的错误，出现在哪个文件的第几行中。这对于用C/C++做的大工程非常的管用。 

综上所述32条，都是为了三大目的-- 
　　1、程序代码的易读性。 
　　2、程序代码的可维护性， 
　　3、程序代码的稳定可靠性。 
　　 
有修养的程序员，就应该要学会写出这样的代码！这是任何一个想做编程高手所必需面对的细小的问题，编程高手不仅技术要强，基础要好，而且最重要的是要有“修养”！ 
好的软件产品绝不仅仅是技术，而更多的是整个软件的易维护和可靠性。　　 
软件的维护有大量的工作量花在代码的维护上，软件的Upgrade，也有大量的工作花在代码的组织上，所以好的代码，清淅的，易读的代码，将给大大减少软件的维护和升级成本。