編程修養

編程修養

    什麼是好的程序員？是不是懂得很多技術細節？還是懂底層編程？還是編程速度比 較快？我覺得都不是。對於一些技術細節來說和底層的技術，只要看幫助，查資料 就能找到，對於速度快，只要編得多也就熟能生巧了。 我認爲好的程序員應該有以下幾方面的素質：
1、有專研精神，勤學善問、舉一反三。
2、積極向上的態度，有創造性思維。
3、與人積極交流溝通的能力，有團隊精神。
4、謙虛謹慎，戒驕戒燥。

5、寫出的代碼質量高。包括：代碼的穩定、易讀、規範、易維護、專業。

    這些都是程序員的修養，這裏我想談談"編程修養"，也就是上述中的第 5 點。

    有句話叫"字如其人"，我想從程序上也能看出一 個程序員的優劣。因爲，程序是程序員的作品，作品的好壞直接關係到程序員的聲譽和素質。而"修養"好的程序員一定能做出好的程序和軟件。 有個成語叫"獨具匠心"，意思是做什麼都要做得很專業，很用心，如果你要做一個"匠"，也就是造詣高深的人，那麼，從一件很簡單的作品上就能看出你有沒有"匠"的特性，我覺得做一個程序員不難，但要做一個"程序匠"就不簡單了。編程序很簡單，但編出有質量的程序就難了。

    我在這裏不討論過深的技術，我只想在一些容易讓人忽略的東西上說一說，雖然這 些東西可能很細微，但如果你不注意這些細微之處的話，那麼他將會極大的影響你的整個軟件質量，以及整個軟件程的實施，所謂"千里之堤，毀於蟻穴"。 "細微之處見真功"，真正能體現一個程序的功底恰恰在這些細微之處。 這就是程序員的--編程修養。我總結了在用 C/C++語言（主要是 C 語言）進行程序寫作上的三十二個"修養"，通過這些，你可以寫出質量高的程序，同時也會讓看你 程序的人漬漬稱道，那些看過你程序的人一定會說："這個人的編程修養不錯"。

----------------------------------------------------------------------------------------------------------------------------------------------------------

01、版權和版本
02、縮進、空格、換行、空行、對齊
03、程序註釋
04、函數的[in][out]參數
05、對系統調用的返回進行判斷
06、if 語句對出錯的處理
07、頭文件中的#ifndef
08、在堆上分配內存
09、變量的初始化
10、h 和 c 文件的使用
11、出錯信息的處理
12、常用函數和循環語句中的被計算量
13、函數名和變量名的命名
14、函數的傳值和傳指針
15、修改別人程序的修養
16、把相同或近乎相同的代碼形成函數和宏
17、表達式中的括號
18、函數參數中的 const
19、函數的參數個數
20、函數的返回類型，不要省略
21、goto 語句的使用
22、宏的使用
23、static 的使用
24、函數中的代碼尺寸
25、typedef 的使用
26、爲常量聲明宏
27、不要爲宏定義加分號
28、||和&&的語句執行順序
29、儘量用 for 而不是 while 做循環
30、請 sizeof 類型而不是變量
31、不要忽略 Warning
32、書寫 Debug 版和 Release 版的程序

----------------------------------------------------------------------------------------------------------------------------------------------------------

01、版權和版本

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

/********************************************************************
*
*     文件名：network.c
*
*     文件描述：網絡通訊函數集
*
*     創建人： Eric Lee, 2017 年 10 月 22 日
*
*     版本號：1.0
*
*     修改記錄：
*
********************************************************************/

而對於函數來說，應該也有類似於這樣的註釋：

/*============================================
*
* 函 數 名：XXX
*
* 參     數：
*
*     type name [IN] : descripts
*
* 功能描述:
*
*     ..............
*
* 返 回 值：成功 TRUE，失敗 FALSE
*
* 拋出異常：
*
* 作     者：Eric Lee, 2017 年 10 月 22 日
*
=============================================*/

    這樣的描述可以讓人對一個函數，一個文件有一個總體的認識，對代碼的易讀性和易維護性有很大的好處。這是好的作品產生的開始。

----------------------------------------------------------------------------------------------------------------------------------------------------------

02、縮進、空格、換行、空行、對齊

1） 縮進應該是每個程序都會做的，只要學程序過程序就應該知道這個，但是我仍然看過不縮進的程序，或是亂縮進的程序，如果你的公司還有寫程序不縮進的程序 員，請毫不猶豫的開除他吧，並以破壞源碼罪起訴他，還要他賠償讀過他程序的人的精神損失費。縮進，這是不成文規矩，我再重提一下吧，一個縮進一般是一個TAB 鍵或是 4 個空格。（最好用 TAB 鍵）
2）空格。空格能給程序代來什麼損失嗎？沒有，有效的利用空格可以讓你的程序 讀進來更加賞心悅目。而不一堆表達式擠在一起。看看下面的代碼：

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 ){
}

3） 換行。不要把語句都寫在一行上，這樣很不好。如：

for(i=0;i<'0'||a[i]>'9')&&(a[i]<'a'||a[i]>'z')) break;

    這種即無空格，又無換行的程序在寫什麼啊？加上空格和換行吧。

for (i=0; 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' )

4） 空行。不要不加空行，空行可以區分不同的程序塊，程序塊間，最好加上空行。
5） 對齊。用 TAB 鍵對齊你的一些變量的聲明或註釋，一樣會讓你的程序好看一 些。如：

typedef struct _pt_man_t_ {
int	numProc;	/* 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; 

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

----------------------------------------------------------------------------------------------------------------------------------------------------------

03、代碼註釋

    養成寫程序註釋的習慣，這是每個程序員所必須要做的工作。我看過那種幾千行， 卻居然沒有一行註釋的程序。這就如同在公路上駕車卻沒有路標一樣。用不了多久，連自己都不知道自己的意圖了，還要花上幾倍的時間纔看明白，這種浪費別人和自己的時間的人，是最爲可恥的人。是的，你也許會說，你會寫註釋，真的嗎？註釋的書寫也能看出一個程序員的功底。

    一般來說你需要至少寫這些地方的註釋：文件的註釋、函數的註釋、變量的注 釋、算法的註釋、功能塊的程序註釋。主要就是記錄你這段程序是幹什麼的？你的意圖是什麼？你這個變量是用來做什麼的？等等。不要以爲註釋好寫，有一些算法是很難說或寫出來的，只能意會，我承認有這種情況的時候，但你也要寫出來，正好可以訓練一下自己的表達能力。而表達能力正是 那種悶頭搞技術的技術人員最缺的，你有再高的技術，如果你表達能力不行，你的
技術將不能得到充分的發揮。因爲，這是一個團隊的時代。 好了，說幾個註釋的技術細節：
    1）對於行註釋（"//"）比塊註釋（"/* */"）要好的說法，我並不是很同意。因爲一些 老版本的 C 編譯器並不支持行註釋，所以爲了你的程序的移植性，請你還是儘量使用塊註釋。
    2）你也許會爲塊註釋的不能嵌套而不爽，那麼你可以用預編譯來完成這個功能。 使用"#if 0"和"#endif"括起來的代碼，將不被編譯，而且還可以嵌套。

----------------------------------------------------------------------------------------------------------------------------------------------------------

04、函數的[in][out]參數

    我經常看到這樣的程序：

FuncName(char* str)
{
	int len = strlen(str);
	.....
}
char *GetUserName(struct user* pUser)
{
	return pUser->name;
}

    不！請不要這樣做。
    你應該先判斷一下傳進來的那個指針是不是爲空。如果傳進來的指針爲空的話，那 麼，你的一個大的系統就會因爲這一個小的函數而崩潰。一種更好的技術是使用斷言（assert），這裏我就不多說這些技術細節了。當然，如果是在 C++中，引用要比指針好得多，但你也需要對各個參數進行檢查。 寫有參數的函數時，首要工作，就是要對傳進來的所有參數進行合法性檢查。而對於傳出的參數也應該進行檢查，這個動作當然應該在函數的外部，也就是說，調用完一個函數後，應該對其傳出的值進行檢查。 當然，檢查會浪費一點時間，但爲了整個系統不至於出現"非法操作"或是"Core Dump"的系統級的錯誤，多花這點時間還是很值得的。

----------------------------------------------------------------------------------------------------------------------------------------------------------

05、對系統調用的返回進行判斷

    繼續上一條，對於一些系統調用，比如打開文件，我經常看到，許多程序員對 fopen 返回的指針不做任何判斷，就直接使用了。然後發現文件的內容怎麼也讀不出去，或是怎麼也寫不進去。還是判斷一下吧：

ifstream inFile;   
inFile.open(filename);//inFile與文件相關聯。  
if(!inFile.is_open())//檢查是否可以打開文件。   
{  
	cout<<"can not open the file:"<<filename<<endl;  
	exit(EXIT_FAILURE);  
}  

    其它還有許多啦，比如：socket 返回的 socket 號，malloc 返回的內存。請對這些系統調用返回的東西進行判斷。

----------------------------------------------------------------------------------------------------------------------------------------------------------

06、if 語句對出錯的處理

if ( ch >= '0' && ch <= '9' )
{
	/* 正常處理代碼 */
}
else
{
	/* 輸出錯誤信息 */
	printf("error ......\n");
	return ( FALSE );
} 

    這種結構很不好，特別是如果"正常處理代碼"很長時，對於這種情況，最好不要用else。先判斷錯誤，如：

if ( ch < '0' || ch > '9' )
{
	/* 輸出錯誤信息 */
	printf("error ......\n");
	return ( FALSE );
}
/* 正常處理代碼 */

    這樣的結構，不是很清楚嗎？先突出錯誤的條件，讓別人在使用你的函數的時候， 第一眼就能看到不合法的條件，於是就會更下意識的避免。

----------------------------------------------------------------------------------------------------------------------------------------------------------

07、頭文件中的#ifndef
    千萬不要忽略了頭件的中的#ifndef，這是一個很關鍵的東西。比如你有兩個 C 文 件，這兩個 C 文件都 include 了同一個頭文件。而編譯時，這兩個 C 文件要一同編 譯成一個可運行文件，於是問題來了，大量的聲明衝突。 還是把頭文件的內容都放在#ifndef 和#endif 中吧。不管你的頭文件會不會被多個文 件引用，你都要加上這個。一般格式是這樣的：

#ifndef _STDIO_H_
#define _STDIO_H_
 
......
 
#endif

----------------------------------------------------------------------------------------------------------------------------------------------------------

08、在堆上分配內存

    對於 malloc 和 free 的操作有以下規則：
    1）配對使用，有一個 malloc，就應該有一個 free。（C++中對應爲 new 和 delete）
    2）儘量在同一層上使用，不要像上面那種，malloc 在函數中，而 free 在函數外。 最好在同一調用層上使用這兩個函數。
    3） malloc 分配的內存一定要初始化。free 後的指針一定要設置爲 NULL。
注：雖然現在的操作系統（如：UNIX 和 Win2k/NT）都有進程內存跟蹤機制，也 就是如果你有沒有釋放的內存，操作系統會幫你釋放。但操作系統依然不會釋放你 程序中所有產生了 Memory Leak 的內存，所以，最好還是你自己來做這個工作。（有的時候不知不覺就出現 Memory Leak 了，而且在幾百萬行的代碼中找無異於 海底撈針，Rational 有一個工具叫 Purify，可能很好的幫你檢查程序中的 Memory Leak）

----------------------------------------------------------------------------------------------------------------------------------------------------------

09、變量的初始化

    接上一條，變量一定要被初始化再使用。C/C++編譯器在這個方面不會像 JAVA 一樣幫你初始化，這一切都需要你自己來，如果你使用了沒有初始化的變量，結果未知。好的程序員從來都會在使用變量前初始化變量的。如：
    1）對 malloc 分配的內存進行 memset 清零操作。（可以使用 calloc 分配一塊全 零的內存）

    2）對一些棧上分配的 struct 或數組進行初始化。（最好也是清零）
    不過話又說回來了，初始化也會造成系統運行時間有一定的開銷，所以，也不要對 所有的變量做初始化，這個也沒有意義。好的程序員知道哪些變量需要初始化，哪些則不需要。如：以下這種情況，則不需要。

char *pstr; 	/* 一個字符串 */
pstr = ( char* ) malloc( 50 ); if ( pstr == NULL ) exit(0); 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 和 .cpp 文件的使用

    H 文件和 C 文件怎麼用呢？一般來說，H 文件中是 declare（聲明），C 文件中是define（定義）。因爲 C 文件要編譯成庫文件（Windows 下是.obj/.lib，UNIX 下 是.o/.a），如果別人要使用你的函數，那麼就要引用你的 H 文件，所以，H 文件中一般是變量、宏定義、枚舉、結構和函數接口的聲明，就像一個接口說明文件一 樣。而 C 文件則是實現細節。H 文件和 C 文件最大的用處就是聲明和實現分開。這個特性應該是公認的了，但我仍然看到有些人喜歡把函數寫在 H 文件中，這種習慣很不好。（如果是 C++話，對於其模板函數，在 VC 中只有把實現和聲明都寫在一個文件中，因爲 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[]; 的外部聲明，讓編譯器在鏈接時纔去管他，這樣一來，就 只會有一個 errmsg 存在於執行文件中，而且，這樣做很利於封裝。 我曾遇到過的最瘋狂的事，就是在我的目標文件中，這個 errmsg 一共有 112 個副 本，執行文件有 8M 左右。當我把 errmsg 放到 C 文件中，併爲一千多個 C 文件加 上了 extern 的聲明後，所有的函數庫文件尺寸都下降了 20%左右，而我的執行文 件只有 5M 了。一下子少了 3M 啊。

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

----------------------------------------------------------------------------------------------------------------------------------------------------------

11、出錯信息的處理

    你會處理出錯信息嗎？哦，它並不是簡單的輸出。看下面的示例：

if ( p == NULL )
{
	printf ( "ERR: The pointer is NULL\n" );
}

    告別學生時代的編程吧。這種編程很不利於維護和管理，出錯信息或是提示信息， 應該統一處理，而不是像上面這樣，寫成一個"硬編碼"。第 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",
	......	
};	

/* 聲明錯誤代碼全局變量 */
long errno = 0;
 
/* 打印出錯信息函數 */
void perror( char* info)
{
	if ( info )
	{
		printf("%s: %s\n", info, errmsg[errno] );
		return;
}
	printf("Error: %s\n", errmsg[errno] );
}

    這個基本上是 ANSI 的錯誤處理實現細節了，於是當你程序中有錯誤時你就可以這樣處理：

bool CheckPermission( char* userName )
{
	if ( strcpy(userName, "root") != 0 )
	{
		errno = ERR_PERMISSION_DENIED;
		return (FALSE);
}
	...
}
 
main()
{
	...
	if (! CheckPermission( username ) )
	{
		perror("main()");
	}
	...
}

    一個即有共性，也有個性的錯誤信息處理，這樣做有利同種錯誤出一樣的信息，統 一用戶界面，而不會因爲文件打開失敗，A 程序員出一個信息，B 程序員又出一個信息。而且這樣做，非常容易維護。代碼也易讀。 當然，物極必反，也沒有必要把所有的輸出都放到 errmsg 中，抽取比較重要的出 錯信息或是提示信息是其關鍵，但即使這樣，這也包括了大多數的信息。

----------------------------------------------------------------------------------------------------------------------------------------------------------

12、常用函數和循環語句中的被計算量

for( i=0; i<1000; i++ )
{ 
	GetLocalHostName( hostname );
	...
}

    GetLocalHostName 的意思是取得當前計算機名，在循環體中，它會被調用 1000次啊。這是多麼的沒有效率的事啊。應該把這個函數拿到循環體外，這樣只調用一 次，效率得到了很大的提高。雖然，我們的編譯器會進行優化，會把循環體內的不變的東西拿到循環外面，但是，你相信所有編譯器會知道哪些是不變的嗎？我覺得編譯器不可靠。最好還是自己動手吧。同樣，對於常用函數中的不變量，如：

GetLocalHostName(char* name)
{
	char funcName[] = "GetLocalHostName";
	sys_log( "%s begin......", funcName );
	...
	sys_log( "%s end......", funcName );
}

    如果這是一個經常調用的函數，每次調用時都要對 funcName 進行分配內存，這個開銷很大啊。把這個變量聲明成 static吧，當函數再次被調用時，就會省去了分配內存的開銷，執行效率也很好。

----------------------------------------------------------------------------------------------------------------------------------------------------------

13、函數名和變量名的命名

    我看到許多程序對變量名和函數名的取名很草率，特別是變量名，什麼 a,b,c,aa,bb,cc，還有什麼 flag1,flag2, cnt1, cnt2，這同樣是一種沒有"修養"的行爲。 即便加上好的註釋。好的變量名或是函數名，我認爲應該有以下的規則：

    1）直觀並且可以拼讀，可望文知意，不必"解碼"。
    2）名字的長度應該即要最短的長度，也要能最大限度的表達其含義。
    3）不要全部大寫，也不要全部小寫，應該大小寫都有，如：GetLocalHostName 或是 UserAccount。
    4）可以簡寫，但簡寫得要讓人明白，如：ErrorCode -> ErrCode, ServerListener -> ServLisner，UserAccount -> UsrAcct 等。
    5）爲了避免全局函數和變量名字衝突，可以加上一些前綴，一般以模塊簡稱做爲前綴。
    6）全局變量統一加一個前綴或是後綴，讓人一看到這個變量就知道是全局的。
    7）用匈牙利命名法命名函數參數，局部變量。但還是要堅持"望文生意"的原則。
    8）與標準庫（如：STL）或開發庫（如：MFC）的命名風格保持一致。

----------------------------------------------------------------------------------------------------------------------------------------------------------

14、函數的傳值和傳指針

    向函數傳參數時，一般而言，傳入非 const 的指針時，就表示，在函數中要修改這個指針把指內存中的數據。如果是傳值，那麼無論在函數內部怎麼修改這個值，也 影響不到傳過來的值，因爲傳值是隻內存拷貝。什麼？你說這個特性你明白了，好吧，讓我們看看下面的這個例程：

void GetVersion(char* pStr)
{
	pStr = malloc(10);
	strcpy ( pStr, "2.0" );
}
main()
{
	char* ver = NULL; 
	GetVersion ( ver );
	...
	free ( ver );
}

    我保證，類似這樣的問題是一個新手最容易犯的錯誤。程序中妄圖通過函數GetVersion 給指針 ver 分配空間，但這種方法根本沒有什麼作用，原因就是--這是傳值，不是傳指針。你或許會和我爭論，我分明傳的是指針啊？再仔細看看，其實，你傳的是指針其實是在傳值。

----------------------------------------------------------------------------------------------------------------------------------------------------------

15、修改別人程序的修養

    當你維護別人的程序時，請不要非常主觀臆斷的把已有的程序刪除或是修改。我經 常看到有的程序員直接在別人的程序上修改表達式或是語句。修改別人的程序時， 請不要刪除別人的程序，如果你覺得別人的程序有所不妥，請註釋掉，然後添加自己的處理程序，畢竟，你不可能 100%的知道別人的意圖，所以爲了可以恢復，請不依賴於 CVS 或是 SourceSafe 這種版本控制軟件，還是要在源碼上給別人看到你 修改程序的意圖和步驟。這是程序維護時，一個有修養的程序員所應該做的。如下所示，這就是一種比較好的修改方法：

/*
* ----- commented by haoel 2017/11/13------
*
* 	char* p = ( char* ) malloc( 10 );
* 	memset( p, 0, 10 );
*/
 
/* ------ Added by haoel 	2017/11/13 ----- */
char* p = ( char* )calloc( 10, sizeof char );
/* ---------------------------------------- */

    當然，這種方法是在軟件維護時使用的，這樣的方法，可以讓再維護的人很容易知 道以前的代碼更改的動作和意圖，而且這也是對原作者的一種尊敬。以"註釋 - 添加"方式修改別人的程序，要好於直接刪除別人的程序。

----------------------------------------------------------------------------------------------------------------------------------------------------------

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 使用，利於程序的維護和避免犯一 些錯誤。C++中對 const 定義的很嚴格，所以 C++中要多多的使用 const，const 的成員函數，const 的變量，這樣會對讓你的代碼和你的程序更加完整和易讀。

----------------------------------------------------------------------------------------------------------------------------------------------------------

19、函數的參數個數（多了請用結構）

    函數的參數個數最好不要太多，一般來說 6 個左右就可以了，衆多的函數參數會讓讀代碼的人一眼看上去就很頭昏，而且也不利於維護。如果參數衆多，還請使用結 構來傳遞參數。這樣做有利於數據的封裝和程序的簡潔性。也利於使用函數的人，因爲如果你的函數個數很多，比如 12 個，調用者很容易搞錯參數的順序和個數，而使用結構struct來傳遞參數，就可以不管參數的順序。 而且，函數很容易被修改，如果需要給函數增加參數，不需要更改函數接口，只需 更改結構體和函數內部處理，而對於調用函數的程序來說，這個動作是透明的。

----------------------------------------------------------------------------------------------------------------------------------------------------------

20、函數的返回類型，不要省略

    我看到很多程序寫函數時，在函數的返回類型方面不太注意。如果一個函數沒有返 回值，也請在函數前面加上 void 的修飾。而有的程序員偷懶，在返回 int 的函數則 什麼不修飾（因爲如果不修飾，則默認返回 int），這種習慣很不好，還是爲了原代碼的易讀性，加上 int 吧。
    所以函數的返回值類型，請不要省略。另外，對於 void 的函數，我們往往會忘了 return，由於某些 C/C++的編譯器比較敏感，會報一些警告，所以即使是 void 的函數，我們在內部最好也要加上 return 的 語句，這有助於代碼的編譯。

----------------------------------------------------------------------------------------------------------------------------------------------------------

21、goto 語句的使用

    慎用！！！

----------------------------------------------------------------------------------------------------------------------------------------------------------

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的變量，其實就是全局變量，只不過他是有作用域的全局變量。比如一個函數中的static 變量：

char *getConsumerName()
{
	static int cnt = 0;
	cnt++;
	....
}

    cnt 變量的值會跟隨着函數的調用次而遞增，函數退出後，cnt 的值還存在，只是cnt 只能在函數中才能被訪問。而 cnt 的內存也只會在函數第一次被調用時纔會被 分配和初始化，以後每次進入函數，都不爲 static 分配了，而直接使用上一次的值。對於一些被經常調用的函數內的常量，最好也聲明成 static（參見第 12 條）但 static 的最多的用處卻不在這裏，其最大的作用的控制訪問，在 CPP 中如果一個函 數或是一個全局變量被聲明爲 static，那麼，這個函數和這個全局變量，將只能在這個 CPP 文件中被訪問，如果別的 CPP文件中調用這個 CPP文件中的函數，或是使用其中的全局（用 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
	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 HostInfoArray;於是，當我們用其定義變量時，會顯得十分易讀。如：HostInfo* phinfo; RsrcReqHandler* pRsrcHand;

    這種方式的易讀性，在函數的參數中十分明顯。關鍵是在程序種使用 typedef 後，幾乎所有的程序中的類型聲明都顯得那麼簡潔和 清淅，而且易於維護，這纔是 typedef 的關鍵。

----------------------------------------------------------------------------------------------------------------------------------------------------------

26、爲常量聲明爲const

    最好不要在程序中出現數字式的"硬編碼"，如：

    int user[120];

    爲這個 120 聲明一個宏吧。爲所有出現在程序中的這樣的常量都聲明一個宏吧。比 如 TimeOut 的時間，最大的用戶數量，還有其它，只要是常量就應該聲明成宏。 如果，突然在程序中出現下面一段代碼：

for ( i=0; i<120; i++)
{
	....
}

    120 是什麼？爲什麼會是 120？這種"硬編碼"不僅讓程序很讀，而且也讓程序很不好維護，如果要改變這個數字，得同時對所有程序中這個 120 都要做修改，這對修 改程序的人來說是一個很大的痛苦。所以還是把常量聲明成常量，這樣，一改百改，而且也很利於程序閱讀。
    有的程序員喜歡爲這種變量聲明全局變量，其實，全局變量應該儘量的少用，全局 變量不利於封裝，也不利於維護，而且對程序執行空間有一定的開銷，一不小心就造成系統換頁，造成程序執行速度效率等問題。所以聲明成常量，即可以免去全局變量的開銷，也會有速度上的優勢。

----------------------------------------------------------------------------------------------------------------------------------------------------------

27、不要爲宏定義加分號

    有許多程序員不知道在宏定義時是否要加分號，有時，他們以爲宏是一條語句，應該要加分號，這就錯了。當你知道了宏的原理，你會贊同我爲會麼不要爲宏定義加分號的。

----------------------------------------------------------------------------------------------------------------------------------------------------------

28、||和&&的語句執行順序

    條件語句中的這兩個"與"和"或"操作符一定要小心，它們的表現可能和你想像的不 一樣，這裏條件語句中的有些行爲需要和說一下：

    express1 || express2

    先執行表達式 express1 如果爲"真"，express2 將不被執行，express2 僅在 express1 爲"假"時才被執行。因爲第一個表達式爲真了，整個表達式都爲真，所以 沒有必要再去執行第二個表達式了。

    express1 && express2
    先執行表達式 express1 如果爲"假"，express2 將不被執行，express2 僅在 express1 爲"真"時才被執行。因爲第一個表達式爲假了，整個表達式都爲假了，所 以沒有必要再去執行第二個表達式了。於是，他並不是你所想像的所有的表達式都會去執行，這點一定要明白，不然你的程序會出現一些莫明的運行時錯誤。例如，下面的程序：
    記住一點，條件語句中，並非所有的語句都會執行，當你的條件語句非常多時，這 點要尤其注意。

----------------------------------------------------------------------------------------------------------------------------------------------------------

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[i] = (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 輸出調試信息，只需要在在編譯時加上一個參數"-DDEBUG"，如：
    cc -DDEBUG -o target target.c

    於是，預編譯器發現 DEBUG 變量被定義了，就會使用 TRACE 函數。而如果要發 布給用戶了，那麼只需要把取消"-DDEBUG"的參數，於是所有用到 TRACE 宏， 這個宏什麼都沒有，所以源程序中的所有 TRACE 語言全部被替換成了空。一舉兩 得，一箭雙鵰，何樂而不爲呢？
    順便提一下，兩個很有用的系統宏，一個是"     FILE     "，一個是"__LINE__"，分 別表示，所在的源文件和行號，當你調試信息或是輸出錯誤時，可以使用這兩個 宏，讓你一眼就能看出你的錯誤，出現在哪個文件的第幾行中。這對於用 C/C++做 的大工程非常的管用。

----------------------------------------------------------------------------------------------------------------------------------------------------------

綜上所述 32 條，都是爲了三大目的：
1、程序代碼的易讀性。
2、程序代碼的可維護性，
3、程序代碼的穩定可靠性。
    有修養的程序員，就應該要學會寫出這樣的代碼！這是任何一個想做編程高手所必 需面對的細小的問題，編程高手不僅技術要強，基礎要好，而且最重要的是要有" 修養"！
    好的軟件產品絕不僅僅是技術，而更多的是整個軟件的易維護和可靠性。 軟件的維護有大量的工作量花在代碼的維護上，軟件的 Upgrade，也有大量的工作 花在代碼的組織上，所以好的代碼，清淅的，易讀的代碼，將給大大減少軟件的維護和升級成本。