成功軟體開發者的9種程式設計習慣 5 (轉)

成功軟體開發者的9種程式設計習慣 5 (轉)[@more@]6. 寫好註釋

　　要養成寫註釋的習慣。特別是別人難以理解的或變數一定要註釋，一個月後，也許你自己也需要看那註釋呢。

int x = 100;
int y = 1000;

if(x < y)
　　a = 0;
else
　　a = 1;

　　你能知道上面的程式意味著什麼？如果不知道變數x,y和a指的是什麼，那麼很難理解。讓我們給它標個註釋再看吧：

/*
* 檢測損益的程式
*/

int x = 100;
/* x 是賣書的總額*/
int y = 1000
/* y是做書本的費用*/
int a;
/* 確認是否有贏利*/

/* 比較x和y: */
if(x < y)
/* 1指損失 */
　　a = 1;
else
/*0指贏利 */
　　a = 0;

　　這樣註釋，不懂C語言的人也會看懂各語句意味著什麼，各變數指的是什麼。寫註釋是好習慣，但不要什麼都註釋。註釋是為了好理解，不是為了寫長編文章。

int profit = 1;
/* 贏利等於1 ?? */
int loss = 0;
/* 虧損等於 0 ?? */

/* 如果贏利等於1 */
if(profit == 1)
　　/* 列印出“得贏利啦”??*/
　　printf("We made a profit!n");
/* 如果不是 */
　　else
　　/*列印出“我們虧損啦”*/
　　printf("We made a loss!n");


　　這樣註釋是浪費時間。一般是定變數或變數值的時候需要註釋，還有說明程式的目的，使用某個，procedule等的時候也需要。