编程修养（三）

16、把相同或近乎相同的代码形成函数和宏
—————————————————————
 
有人说，最好的程序员，就是最喜欢“偷懒”的程序，其中不无道理。
 
如果你有一些程序的代码片段很相似，或直接就是一样的，请把他们放在一个函数中。而
如果这段代码不多，而且会被经常使用，你还想避免函数调用的开销，那么就把他写成宏
吧。
 
千万不要让同一份代码或是功能相似的代码在多个地方存在，不然如果功能一变，你就要
修改好几处地方，这种会给维护带来巨大的麻烦，所以，做到“一改百改”，还是要形成
函数或是宏。
 
 
 
17、表达式中的括号
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指针所指向的内存时，会报一个Warning
。这会引起程序员的注意。
 
C++中对const定义的就很严格了，所以C++中要多多的使用const，const的成员函数，cons
t的变量，这样会对让你的代码和你的程序更加完整和易读。（关于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()
    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:
     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个地方用到，宏展开后会很不得了），相反不能
让程序执行得更快（因为执行文件变大，运行时系统换页频繁）。
 
因此，在决定是用函数，还是用宏时得要小心。
--
 
。                 开始使劲
 
    #define  MAX( (a), (b) )     (a)>(b)?(a):(b)
 
即使是这样，也不这个宏也还是有Bug，因为如果我这样调用 MAX(i++, j++); ， 经过这
个宏以后，i和j都被累加了两次，这绝不是我们想要的。
 
所以，在宏的使用上还是要谨慎考虑，因为宏展开是的结果是很难让人预料的。而且虽然
，宏的执行很快（因为没有函数调用的开销），但宏会让源代码澎涨，使目标文件尺寸变
大，（如：一个50行的宏，程序中有1000个地方用到，宏展开后会很不得了），相反不能
让程序执行得更快（因为执行文件变大，运行时系统换页频繁）。
 
因此，在决定是用函数，还是用宏时得要小心。

23、static的使用
————————
static关键字，表示了“静态”，一般来说，他会被经常用于变量和函数。一个static的
变量，其实就是全局变量，只不过他是有作用域的全局变量。比如一个函数中的static变
量：
 
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，一些程序员使用short，
会比较混乱，最好就是用一个typedef来定义，如：
 
    typedef char bool;
 
一般来说，一个C的工程中一定要做一些这方面的工作，因为你会涉及到跨平台，不同的平
台会有不同的字长，所以利用预编译和typedef可以让你最有效的维护你的代码，如下所示
：
 
    #ifdef SOLARIS2_5
      typedef boolean_t     BOOL_T;
    #else
    #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声明一个宏吧。为所有出现在程序中的这样的常量都声明一个
宏吧。比如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;
    }
 
这一点非常符合习惯，而且，如果忘加了分号，编译器给出的错误提示，也会让我们很容
易看懂的。
--
                   开始使劲
    #define PRINT_NLINE(n)  while ( n-- >0 ) { PRINT_LINE; }
 
都不要在最后加上分号，当我们在程序中使用时，为之加上分号，
 
    main()
    {
        char *p = LINE;
        PRINT_LINE;
    }
 
这一点非常符合习惯，而且，如果忘加了分号，编译器给出的错误提示，也会让我们很容
易看懂的。