国产99久久精品一区二区 夜夜躁日日躁 _亚洲三级av在线_www.av视频_国产精品一区二区三区久久

養成好習慣 關于代碼注釋的7個技巧

2016-07-02 08:33:56

 1. 對不同級別的代碼進行注釋
對于不同級別的代碼塊，要使用統一的方法來進行注釋。例如：
對于每一個類，需要包含一段簡明扼要的描述，作者和上一次修改的時間
對于每一個方法，需要包含這個方法的用途，功能，參數以及返回結果
當你在一個團隊里面的時候，采用一套注釋的標準是非常重要的。當然，使用一種大家都認可的注釋約定和工具(例如C#的XML注釋和Java的Javadoc)在一定程度上能推動這項任務。
2. 使用段落注釋
首先把代碼塊分解成多個“段落”，每一個段落都執行單一的任務;然后在每一個“段落”開始之前添加注釋，告訴閱讀代碼的人接下來的這段代碼是干什么用的
 
3. 對齊注釋行
對于那些在行末寫有注釋的代碼，應該對齊注釋行來使得方便閱讀
有些開發人員使用tab來對齊注釋，而另外一些人會用空格來對齊。由于tab在不同的編輯器和集成開發環境中會有所不同，所以最佳的方法是使用空格來對齊注釋行。
 
4. 不要侮辱閱讀者的智慧
要避免沒用的注釋，例如
 
這不單把時間浪費在寫沒用的注釋上面，同時也在分散讀者的注意力。
5. 要有禮貌
應當避免沒有禮貌的注釋，例如“要注意一些愚蠢的用戶會輸入一個負數”，或者“修正由菜鳥工程師寫的愚蠢得可憐的代碼而導致的副作用”。這樣的注釋對于代碼的寫注釋的人來說并沒有任何好處，同時你永遠都不會知道將來這些注釋會被誰來閱讀，你的老板，一個客戶或者是剛才被你數落的愚蠢得可憐的工程師。
6. 直截了當
不要在注釋里面寫過多的廢話。避免在注釋里面賣弄ASCII藝術，寫笑話，作詩和過于冗長。簡而言之就是保持注釋的簡單和直接。
7. 使用統一的風格
有些人覺得注釋應該讓非程序員也能看懂。另外一些人覺得注釋需要面對的讀者只是程序員。無論如何，正如Successful Strategies for Commenting Code中所說的，最重要的是注釋的風格需要統一，并且總是面向相同的讀者。就自己而論，我懷疑非程序員是否會去讀代碼，所以我覺得注釋應該面向程序員來寫。