代碼注釋和格式化的目的都是為了讓代碼更容易閱讀和理解，提升了代碼的可維護(hù)性，下面是 10 個關(guān)于代碼注釋和格式的 10 個***實(shí)踐（特別是 Java）。

代碼注釋

注釋是代碼的一部分，在統(tǒng)計(jì)代碼行時注釋也包含在內(nèi)，非常重要。一段無任何注釋的代碼很可能是完全無用。盡管有些極端的建議說代碼應(yīng)該有自注釋的方法，不過我們還是建議注釋良好代碼的必要條件。

1、只在需要的時候編寫注釋

不要為每行代碼都編寫注釋，無用而且降低可讀性，例如：

• int count = 0; // 給 count 變量設(shè)置初始值，這人人都能看懂 (?!?)

缺少注釋會增加代碼維護(hù)難度和實(shí)踐，首先變量和方法名應(yīng)該是可理解和自注釋的，下面是兩個不好的例子：

int s = sqrt(v1) + v2 / v3 + fread(s). getChar(0) //(?!?) 

List<int> getVal(int val, int len, String op) //(?!?) 

2、不要編寫錯誤的注釋，比無注釋更可惡

3、為非常重要的變量編寫注釋，而不是使用自文檔風(fēng)格

4、為所有的公開的方法和接口編寫注釋，這是必須的

5、應(yīng)該刪除文檔中一些無用的內(nèi)容，例如 todo 之類的

代碼格式化

很多的開發(fā)工具都提供代碼格式化的功能，例如maven checkstyle ，并且這些格式化操作可在代碼保存時自動進(jìn)行，但這些工具格式化的規(guī)則多少跟每個公司的要求不同，所以在使用前應(yīng)該進(jìn)行設(shè)置以便跟公司代碼格式規(guī)范一致。

下面是一些對于代碼格式化的建議：

1. 統(tǒng)一使用括號的方式：你可以在同一行使用括號或者換一個新行，這都沒關(guān)系，關(guān)鍵是要一致。
2. 統(tǒng)一空行使用的規(guī)則，例如方法結(jié)束后可以來三個空行，是否每行代碼都用空行隔開或者不，這些依照自身的習(xí)慣而行，但要統(tǒng)一。
3. 縮進(jìn)的處理方式統(tǒng)一
4. 每行的字符數(shù)應(yīng)該有所限制，提升代碼可讀性，一般 80 左右個字符最為合適
5. 代碼中的空格使用要一致，例如：

操作符和變量：

a += b , c = 0; (a == b) 

語句和括號之間：

if (value) {, public class A { 

循環(huán)之中：

for (int i = 0; i < length; i++) 

類型轉(zhuǎn)換：

(int) value , (String) value 

英文：http://codebuild.blogspot.com/2012/03/10-best-practices-of-code-commenting.html

原文鏈接：http://www.oschina.net/question/12_45345

【編輯推薦】

1. 告別無止境的增刪改查：Java代碼生成器
2. 推薦給JavaScript開發(fā)人員的10個工具
3. 程序員漫畫四幅：要錢還是要命？
4. Java程序員應(yīng)該了解的10個面向?qū)ο笤O(shè)計(jì)原則
5. 一個人是否能成為程序員是上天注定的