編程修養－C語言篇（二）

1、版權和版本
———————
　　好的程序員會給自己的每個函數，每個文件，都注上版權和版本。
 
　　對于C/C++的文件，文件頭應該有類似這樣的注釋：

/************************************************************************
*
*   文件名：network.c
*
*   文件描述：網絡通訊函數集
*
*   創建人： Hao Chen, 2003年2月3日
*
*   版本號：1.0
*
*   修改記錄：
*
*
************************************************************************/
 
　　而對于函數來說，應該也有類似于這樣的注釋：
 
/*================================================================
*
* 函 數 名：XXX
*
* 參    數：
*
*        type name [IN] : descripts
*
* 功能描述:
*
*        ..............
*
* 返 回 值：成功TRUE，失敗FALSE
*
* 拋出異常：
*
* 作    者：ChenHao 2003/4/2
*
*
================================================================*/
 
　　這樣的描述可以讓人對一個函數，一個文件有一個總體的認識，對代碼的易讀性和易維護
性有很大的好處。這是好的作品產生的開始。
 
2、縮進、空格、換行、空行、對齊
————————————————

i) 縮進應該是每個程序都會做的，只要學程序過程序就應該知道這個，但是我仍然看過不
縮進的程序，或是亂縮進的程序，如果你的公司還有寫程序不縮進的程序員，請毫不猶豫
的開除他吧，并以破壞源碼罪起訴他，還要他賠償讀過他程序的人的精神損失費?？s進，
這是不成文規矩，我再重提一下吧，一個縮進一般是一個TAB鍵或是4個空格。（最好用TAB
鍵）
 
ii) 空格。空格能給程序代來什么損失嗎？沒有，有效的利用空格可以讓你的程序讀進來
更加賞心悅目。而不一堆表達式擠在一起?？纯聪旅娴拇a：
 
    ha=(ha*128+*key++)%tabPtr->size;
 
    ha = ( ha * 128 + *key++ ) % tabPtr->size;
 
 
    有空格和沒有空格的感覺不一樣吧。一般來說，語句中要在各個操作符間加空格，函
數調用時，要以各個參數間加空格。如下面這種加空格的和不加的：
 
if ((hProc=OpenProcess(PROCESS_ALL_ACCESS,FALSE,pid))==NULL){
}
 
if ( ( hProc = OpenProcess(PROCESS_ALL_ACCESS, FALSE, pid) ) == NULL ){
}
 
iii) 換行。不要把語句都寫在一行上，這樣很不好。如：
 
    for(i=0;i<len;i++) if((a[i]<'0'||a[i]>'9')&&(a[i]<'a'||a[i]>'z')) break;
 
    我拷，這種即無空格，又無換行的程序在寫什么啊？加上空格和換行吧。
 
    for ( i=0; i<len; i++) {
        if ( ( a[i] < '0' || a[i] > '9' ) &&
             ( a[i] < 'a' || a[i] > 'z' ) ) {
            break;
        }
    }
 
 
    好多了吧？有時候，函數參數多的時候，最好也換行，如：
CreateProcess(
                  NULL,
                  cmdbuf,
                  NULL,
                  NULL,
                  bInhH,
                  dwCrtFlags,
                  envbuf,
                  NULL,
                  &siStartInfo,
                  &prInfo
                 );
 
    條件語句也應該在必要時換行：
 
    if ( ch >= '0' || ch <= '9' ||
         ch >= 'a' || ch <= 'z' ||
         ch >= 'A' || ch <= 'Z' )
 
 
iv) 空行。不要不加空行，空行可以區分不同的程序塊，程序塊間，最好加上空行。如：

    HANDLE hProcess;
    PROCESS_T procInfo;
 
    /* open the process handle */
    if((hProcess = OpenProcess(PROCESS_ALL_ACCESS, FALSE, pid)) == NULL)
    {
        return LSE_MISC_SYS;
    }
 
    memset(&procInfo, 0, sizeof(procInfo));
    procInfo.idProc = pid;
    procInfo.hdProc = hProcess;
    procInfo.misc |= MSCAVA_PROC;
 
    return(0);
 
v) 對齊。用TAB鍵對齊你的一些變量的聲明或注釋，一樣會讓你的程序好看一些。如：
 
typedef struct _pt_man_t_ {
    int     numProc;    /* Number of processes                 */
    int     maxProc;    /* Max Number of processes             */
    int     maxProc;    /* Max Number of processes             */
    int     numEvnt;    /* Number of events                    */
    int     maxEvnt;    /* Max Number of events                */
    HANDLE* pHndEvnt;   /* Array of events                     */
    DWORD   timeout;    /* Time out interval                   */
    HANDLE  hPipe;      /* Namedpipe                           */
    TCHAR   usr[MAXUSR];/* User name of the process            */
    int     numMsg;     /* Number of Message                   */
    int     Msg[MAXMSG];/* Space for intro process communicate */
} PT_MAN_T;
 
　　怎么樣？感覺不錯吧。
 
　　這里主要講述了如果寫出讓人賞心悅目的代碼，好看的代碼會讓人的心情愉快，讀起代碼
也就不累，工整、整潔的程序代碼，通常更讓人歡迎，也更讓人稱道?，F在的硬盤空間這
么大，不要讓你的代碼擠在一起，這樣它們會抱怨你虐待它們的。好了，用“縮進、空格
、換行、空行、對齊”裝飾你的代碼吧，讓他們從沒有秩序的土匪中變成一排排整齊有秩
序的正規部隊吧。
 
3、程序注釋
——————
　
　　養成寫程序注釋的習慣，這是每個程序員所必須要做的工作。我看過那種幾千行，卻居然
沒有一行注釋的程序。這就如同在公路上駕車卻沒有路標一樣。用不了多久，連自己都不
知道自己的意圖了，還要花上幾倍的時間才看明白，這種浪費別人和自己的時間的人，是
最為可恥的人。
 
　　是的，你也許會說，你會寫注釋，真的嗎？注釋的書寫也能看出一個程序員的功底。一般
來說你需要至少寫這些地方的注釋：文件的注釋、函數的注釋、變量的注釋、算法的注釋
、功能塊的程序注釋。主要就是記錄你這段程序是干什么的？你的意圖是什么？你這個變
量是用來做什么的？等等。
 
　　不要以為注釋好寫，有一些算法是很難說或寫出來的，只能意會，我承認有這種情況的時
候，但你也要寫出來，正好可以訓練一下自己的表達能力。而表達能力正是那種悶頭搞技
術的技術人員最缺的，你有再高的技術，如果你表達能力不行，你的技術將不能得到充分
的發揮。因為，這是一個團隊的時代。
 
　　好了，說幾個注釋的技術細節：
 
i) 對于行注釋（“//”）比塊注釋（“/* */”）要好的說法，我并不是很同意。因為一
些老版本的C編譯器并不支持行注釋，所以為了你的程序的移植性，請你還是盡量使用塊注
釋。
 
 
ii) 你也許會為塊注釋的不能嵌套而不爽，那么你可以用預編譯來完成這個功能。使用“#
if 0”和“#endif”括起來的代碼，將不被編譯，而且還可以嵌套。 
 
4、函數的[in][out]參數
———————————
 
　　我經?？吹竭@樣的程序：
 
FuncName(char* str)
{
    int len = strlen(str);
    .....
}
 
char*
GetUserName(struct user* pUser)
{
    return pUser->name;
}
 
 
　　不！請不要這樣做。

　　你應該先判斷一下傳進來的那個指針是不是為空。如果傳進來的指針為空的話，那么，你
的一個大的系統就會因為這一個小的函數而崩潰。一種更好的技術是使用斷言（assert）
，這里我就不多說這些技術細節了。當然，如果是在C++中，引用要比指針好得多，但你也
需要對各個參數進行檢查。
 
　　寫有參數的函數時，首要工作，就是要對傳進來的所有參數進行合法性檢查。而對于傳出
的參數也應該進行檢查，這個動作當然應該在函數的外部，也就是說，調用完一個函數后
，應該對其傳出的值進行檢查。
 
　　當然，檢查會浪費一點時間，但為了整個系統不至于出現“非法操作”或是“Core Dump”
的系統級的錯誤，多花這點時間還是很值得的。 {{分頁}}
 
5、對系統調用的返回進行判斷
——————————————
　　
　　繼續上一條，對于一些系統調用，比如打開文件，我經?？吹?，許多程序員對fopen返回的
指針不做任何判斷，就直接使用了。然后發現文件的內容怎么也讀出不，或是怎么也寫不
進去。還是判斷一下吧：
 
 
    fp = fopen("log.txt", "a");
    if ( fp == NULL ){
        printf("Error: open file errorn");
        return FALSE;
    }
 
　　其它還有許多啦，比如：socket返回的socket號，malloc返回的內存。請對這些系統調用
返回的東西進行判斷。

6、if 語句對出錯的處理
———————————
　　
　　我看見你說了，這有什么好說的。還是先看一段程序代碼吧。
 
    if ( ch >= '0' && ch <= '9' ){
        /* 正常處理代碼 */
    }else{
        /* 輸出錯誤信息 */
        printf("error ......n");
        return ( FALSE );
    }
 
　　這種結構很不好，特別是如果“正常處理代碼”很長時，對于這種情況，最好不要用else
。先判斷錯誤，如：
 
    if ( ch < '0' || ch > '9' ){

        /* 輸出錯誤信息 */
        printf("error ......n");
        return ( FALSE );
    }
 
    /* 正常處理代碼 */
    ......
 
 
　　這樣的結構，不是很清楚嗎？突出了錯誤的條件，讓別人在使用你的函數的時候，第一眼
就能看到不合法的條件，于是就會更下意識的避免。
 
7、頭文件中的#ifndef
——————————
　　
　　千萬不要忽略了頭件的中的#ifndef，這是一個很關鍵的東西。比如你有兩個C文件，這兩
個C文件都include了同一個頭文件。而編譯時，這兩個C文件要一同編譯成一個可運行文件
，于是問題來了，大量的聲明沖突。
 
　　還是把頭文件的內容都放在#ifndef和#endif中吧。不管你的頭文件會不會被多個文件引用
管你的頭文件會不會被多個文件引用，你都要加上這個。一般格式是這樣的：
 
    #ifndef  <標識>
    #define <標識>
 
    ......
    ......
 
    #endif
 
　　<標識>在理論上來說可以是自由命名的，但每個頭文件的這個“標識”都應該是唯一的。
標識的命名規則一般是頭文件名全大寫，前后加下劃線，并把文件名中的“.”也變成下劃
線，如：stdio.h
 
    #ifndef _STDIO_H_
    #define _STDIO_H_
 
    ......
 
    #endif
 
（BTW：預編譯有多很有用的功能。你會用預編譯嗎？）
（BTW：預編譯有多很有用的功能。你會用預編譯嗎？）

8、在堆上分配內存
—————————

　　可能許多人對內存分配上的“棧 stack”和“堆 heap”還不是很明白。包括一些科班出身
的人也不明白這兩個概念。我不想過多的說這兩個東西。簡單的來講，stack上分配的內存
系統自動釋放，heap上分配的內存，系統不釋放，哪怕程序退出，那一塊內存還是在那里
。stack一般是靜態分配內存，heap上一般是動態分配內存。
 
　　由malloc系統函數分配的內存就是從堆上分配內存。從堆上分配的內存一定要自己釋放。
用free釋放，不然就是術語——“內存泄露”（或是“內存漏洞”）—— Memory Leak。
于是，系統的可分配內存會隨malloc越來越少，直到系統崩潰。還是來看看“棧內存”和
“堆內存”的差別吧。
 
    棧內存分配
    —————
    char*
    AllocStrFromStack()
    {
        char pstr[100];

        return pstr;
    }
 
 
    堆內存分配
    —————
    char*
    AllocStrFromHeap(int len)
    {
        char *pstr;
 
        if ( len <= 0 ) return NULL;
        return ( char* ) malloc( len );
    }
 
　　對于第一個函數，那塊pstr的內存在函數返回時就被系統釋放了。于是所返回的char*什么也沒有。而對于第二個函數，是從堆上分配內存，所以哪怕是程序退出時，也不釋放，所以第二個函數的返回的內存沒有問題，可以被使用。但一定要調用free釋放，不然就是Memory Leak！
 
　　在堆上分配內存很容易造成內存泄漏，這是C/C++的最大的“克星”，如果你的程序要穩定，那么就不要出現Memory Leak。所以，我還是要在這里千叮嚀萬囑付，在使用malloc系統蛑齦叮謔褂胢alloc系統函數（包括calloc，realloc）時千萬要小心。
 
　　記得有一個UNIX上的服務應用程序，大約有幾百的C文件編譯而成，運行測試良好，等使用
時，每隔三個月系統就是down一次，搞得許多人焦頭爛額，查不出問題所在。只好，每隔
兩個月人工手動重啟系統一次。出現這種問題就是Memery Leak在做怪了，在C/C++中這種
問題總是會發生，所以你一定要小心。一個Rational的檢測工作——Purify，可以幫你測
試你的程序有沒有內存泄漏。
 
　　我保證，做過許多C/C++的工程的程序員，都會對malloc或是new有些感冒。當你什么時候
在使用malloc和new時，有一種輕度的緊張和惶恐的感覺時，你就具備了這方面的修養了。
 
　　對于malloc和free的操作有以下規則：
 
1) 配對使用，有一個malloc，就應該有一個free。（C++中對應為new和delete）

2) 盡量在同一層上使用，不要像上面那種，malloc在函數中，而free在函數外。最好在同
一調用層上使用這兩個函數。

3) malloc分配的內存一定要初始化。free后的指針一定要設置為NULL。
 
　　注：雖然現在的操作系統（如：UNIX和Win2k/NT）都有進程內存跟蹤機制，也就是如果你
有沒有釋放的內存，操作系統會幫你釋放。但操作系統依然不會釋放你程序中所有產生了M
emory Leak的內存，所以，最好還是你自己來做這個工作。（有的時候不知不覺就出現Mem
ory Leak了，而且在幾百萬行的代碼中找無異于海底撈針，Rational有一個工具叫Purify
蛐械拇脛姓椅摶煊諍５桌陶耄琑ational有一個工具叫Purify
，可能很好的幫你檢查程序中的Memory Leak）
 
9、變量的初始化
————————
　　接上一條，變量一定要被初始化再使用。C/C++編譯器在這個方面不會像JAVA一樣幫你初始
化，這一切都需要你自己來，如果你使用了沒有初始化的變量，結果未知。好的程序員從
來都會在使用變量前初始化變量的。如：
 
    1) 對malloc分配的內存進行memset清零操作。（可以使用calloc分配一塊全零的內存
）

    2) 對一些棧上分配的struct或數組進行初始化。（最好也是清零）
 
　　不過話又說回來了，初始化也會造成系統運行時間有一定的開銷，所以，也不要對所有的
變量做初始化，這個也沒有意義。好的程序員知道哪些變量需要初始化，哪些則不需要。
如：以下這種情況，則不需要。
 
        char *pstr;  /* 一個字符串 */
        pstr = ( char* ) malloc( 50 );
        if ( pstr == NULL ) exit(0);
        strcpy( pstr, "Hello Wrold" );
        strcpy( pstr, "Hello Wrold" );
 
　　但如果是下面一種情況，最好進行內存初始化。（指針是一個危險的東西，一定要初始化
）
 
        char **pstr;  /* 一個字符串數組 */
        pstr = ( char** ) malloc( 50 );
        if ( pstr == NULL ) exit(0);
 
        /* 讓數組中的指針都指向NULL */
        memset( pstr, 0, 50*sizeof(char*) );
 
　　而對于全局變量，和靜態變量，一定要聲明時就初始化。因為你不知道它第一次會在哪里
被使用。所以使用前初始這些變量是比較不現實的，一定要在聲明時就初始化它們。如：
 
    Links *plnk = NULL;  /* 對于全局變量plnk初始化為NULL */
 
10、h和c文件的使用
—————————
—————————
　　
　　H文件和C文件怎么用呢？一般來說，H文件中是declare（聲明），C文件中是define（定義
）。因為C文件要編譯成庫文件（Windows下是.obj/.lib，UNIX下是.o/.a），如果別人要
使用你的函數，那么就要引用你的H文件，所以，H文件中一般是變量、宏定義、枚舉、結
構和函數接口的聲明，就像一個接口說明文件一樣。而C文件則是實現細節。
 
　　H文件和C文件最大的用處就是聲明和實現分開。這個特性應該是公認的了，但我仍然看到
有些人喜歡把函數寫在H文件中，這種習慣很不好。（如果是C++話，對于其模板函數，在V
C中只有把實現和聲明都寫在一個文件中，因為VC不支持export關鍵字）。而且，如果在H
文件中寫上函數的實現，你還得在makefile中把頭文件的依賴關系也加上去，這個就會讓
你的makefile很不規范。
 
　　最后，有一個最需要注意的地方就是：帶初始化的全局變量不要放在H文件中！
 
　　例如有一個處理錯誤信息的結構：
 
char* errmsg[] = {
        /* 0 */       "No error",
        /* 1 */       "Open file error",
        /* 2 */       "Failed in sending/receiving a message",
        /* 3 */       "Bad arguments",
        /* 4 */       "Memeroy is not enough",
        /* 5 */       "Service is down; try later",

        /* 6 */       "Unknow information",
        /* 7 */       "A socket operation has failed",
        /* 8 */       "Permission denied",
        /* 9 */       "Bad configuration file format",
        /* 10 */      "Communication time out",
        ......
        ......
    };
 
　　請不要把這個東西放在頭文件中，因為如果你的這個頭文件被5個函數庫（.lib或是.a）所
用到，于是他就被鏈接在這5個.lib或.a中，而如果你的一個程序用到了這5個函數庫中的
函數，并且這些函數都用到了這個出錯信息數組。那么這份信息將有5個副本存在于你的執
行文件中。如果你的這個errmsg很大的話，而且你用到的函數庫更多的話，你的執行文件
也會變得很大。
 
　　正確的寫法應該把它寫到C文件中，然后在各個需要用到errmsg的C文件頭上加上 extern
char* errmsg[]; 的外部聲明，讓編譯器在鏈接時才去管他，這樣一來，就只會有一個err
msg存在于執行文件中，而且，這樣做很利于封裝。 {{分頁}}
 
　　我曾遇到過的最瘋狂的事，就是在我的目標文件中，這個errmsg一共有112個副本，執行文
件有8M左右。當我把errmsg放到C文件中，并為一千多個C文件加上了extern的聲明后，所
有的函數庫文件尺寸都下降了20%左右，而我的執行文件只有5M了。一下子少了3M啊。
 
［ 備注 ］
—————

　　有朋友對我說，這個只是一個特例，因為，如果errmsg在執行文件中存在多個副本時，可
以加快程序運行速度，理由是errmsg的多個復本會讓系統的內存換頁降低，達到效率提升
。像我們這里所說的errmsg只有一份，當某函數要用errmsg時，如果內存隔得比較遠，會
產生換頁，反而效率不高。
 
　　生副本導致執行文件尺寸變大，不僅增加了系統裝載時間，也會讓一個程序在內存中占更
多的頁面。而對于errmsg這樣數據，一般來說，在系統運行時不會經常用到，所以還是產
生的內存換頁也就不算頻繁。權衡之下，還是只有一份errmsg的效率高。即便是像logmsg
這樣頻繁使用的的數據，操作系統的內存調度算法會讓這樣的頻繁使用的頁面常駐于內存
，所以也就不會出現內存換頁問題了。

11、出錯信息的處理
—————————

　　你會處理出錯信息嗎？哦，它并不是簡單的輸出?？聪旅娴氖纠?
 
    if ( p == NULL ){
        printf ( "ERR: The pointer is NULLn" );
    }
 
　　告別學生時代的編程吧。這種編程很不利于維護和管理，出錯信息或是提示信息，應該統
一處理，而不是像上面這樣，寫成一個“硬編碼”。第10條對這方面的處理做了一部分說
明。如果要管理錯誤信息，那就要有以下的處理：
 
    /* 聲明出錯代碼 */
    #define     ERR_NO_ERROR    0  /* No error                 */
    #define     ERR_OPEN_FILE   1  /* Open file error          */
    #define     ERR_SEND_MESG   2  /* sending a message error  */

    #define     ERR_BAD_ARGS    3  /* Bad arguments            */
    #define     ERR_MEM_NONE    4  /* Memeroy is not enough    */
    #define     ERR_SERV_DOWN   5  /* Service down try later   */
    #define     ERR_UNKNOW_INFO 6  /* Unknow information       */
    #define     ERR_SOCKET_ERR  7  /* Socket operation failed  */
    #define     ERR_PERMISSION  8  /* Permission denied        */
    #define     ERR_BAD_FORMAT  9  /* Bad configuration file   */
    #define     ERR_TIME_OUT   10  /* Communication time out   */
 
    /* 聲明出錯信息 */
    char* errmsg[] = {
        /* 0 */       "No error",
        /* 1 */       "Open file error",
        /* 2 */       "Failed in sending/receiving a message",
        /* 3 */       "Bad arguments",
        /* 4 */       "Memeroy is not enough",
        /* 5 */       "Service is down; try later",
        /* 6 */       "Unknow information",
        /* 7 */       "A socket operation has failed",
        /* 8 */       "Permission denied",
        /* 9 */       "Bad configuration file format",
        /* 10 */      "Communication time out",
        /* 10 */      "Communication time out",
    };
 
    /* 聲明錯誤代碼全局變量 */
    long errno = 0;
 
    /* 打印出錯信息函數 */
    void perror( char* info)
    {
        if ( info ){
            printf("%s: %sn", info, errmsg[errno] );
            return;
        }
 
        printf("Error: %sn", errmsg[errno] );
    }
 
這個基本上是ANSI的錯誤處理實現細節了，于是當你程序中有錯誤時你就可以這樣處理：
 
    bool CheckPermission( char* userName )
    {
        if ( strcpy(userName, "root") != 0 ){
   &