成功软件开发者的9种编程习惯（五）

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等的时候也需要。