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) 縮進應該是每個程序都會做的，只要學程序過程序就應該知道這個，但是我仍然看過不 縮進的程序，或是亂縮進的程序，如果你的公司還有寫程序不縮進的程序員，請毫不猶豫 的開除他吧，并以破壞源碼罪起訴他，還要他賠償讀過他程序的人的精神損失費。縮進， 這是不成文規矩，我再重提一下吧，一個縮進一般是一個TAB鍵或是4個空格。(最好用TAB 鍵)

　　ii) 空格。空格能給程序代來什么損失嗎?沒有，有效的利用空格可以讓你的程序讀進來更加賞心悅目。而不一堆表達式擠在一起。看看下面的代碼：

　　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’9’)&&(a[i]<’a’||a[i]>’z’)) break;

　　我拷，這種即無空格，又無換行的程序在寫什么啊?加上空格和換行吧。

　　for ( i=0; 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 |= MSC***A_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;

　　怎么樣?感覺不錯吧。

　　這里主要講述了如果寫出讓人賞心悅目的代碼，好看的代碼會讓人的心情愉快，讀起代碼也就不累，工整、整潔的程序代碼，通常更讓人歡迎，也更讓人稱道。現在的硬盤空間這么大，不要讓你的代碼擠在一起，這樣它們會抱怨你虐待它們的。好了，用“縮進、空格、換行、空行、對齊”裝飾你的代碼吧，讓他們從沒有秩序的土匪中變成一排排整齊有秩序的正規部隊吧。