Java開發(fā) 注釋規(guī)約

\1. 【強制】類、類屬性、類方法的注釋必須使用 Javadoc 規(guī)范，使用/**內(nèi)容*/格式，不得使用 // xxx 方式。

• 說明：在 IDE 編輯窗口中，Javadoc 方式會提示相關(guān)注釋，生成 Javadoc 可以正確輸出相應(yīng)注釋；在 IDE 中，工程調(diào)用方法時，不進(jìn)入方法即可懸浮提示方法、參數(shù)、返回值的意義，提高閱讀效率。

\2. 【強制】所有的抽象方法（包括接口中的方法）必須要用 Javadoc 注釋、除了返回值、參數(shù)、異常說明外，還必須指出該方法做什么事情，實現(xiàn)什么功能。

• 說明：對子類的實現(xiàn)要求，或者調(diào)用注意事項，請一并說明。

\3. 【強制】所有的類都必須添加創(chuàng)建者和創(chuàng)建日期。

• 說明：在設(shè)置模板時，注意 IDEA 的 @author 為${USER}，而 eclipse 的@author 為${user}，大小寫有區(qū)別，而日期的設(shè)置統(tǒng)一為 yyyy/MM/dd 的格式。

• 正例：

 /**
\* @編程獅 w3cschool.cn
\* @date 2021/03/23
*/

\4. 【強制】方法內(nèi)部單行注釋，在被注釋語句上方另起一行，使用 // 注釋。方法內(nèi)部多行注釋使用 /* */ 注釋，注意與代碼對齊。

\5. 【強制】所有的枚舉類型字段必須要有注釋，說明每個數(shù)據(jù)項的用途。

\6. 【推薦】與其“半吊子”英文來注釋，不如用中文注釋把問題說清楚。專有名詞與關(guān)鍵字保持英文原文即可。

• 反例：“TCP 連接超時”解釋成“傳輸控制協(xié)議連接超時”，理解反而費腦筋。

\7. 【推薦】代碼修改的同時，注釋也要進(jìn)行相應(yīng)的修改，尤其是參數(shù)、返回值、異常、核心邏輯等的修改。

• 說明：代碼與注釋更新不同步，就像路網(wǎng)與導(dǎo)航軟件更新不同步一樣，如果導(dǎo)航軟件嚴(yán)重滯后，就失去了導(dǎo)航的意義。

\8. 【推薦】在類中刪除未使用的任何字段、方法、內(nèi)部類；在方法中刪除未使用的任何參數(shù)聲明與內(nèi)部變量。

\9. 【參考】謹(jǐn)慎注釋掉代碼。在上方詳細(xì)說明，而不是簡單地注釋掉。如果無用，則刪除。

• 說明：代碼被注釋掉有兩種可能性：1）后續(xù)會恢復(fù)此段代碼邏輯。2）永久不用。前者如果沒有備注信息，難以知曉注釋動機。后者建議直接刪掉即可，假如需要查閱歷史代碼，登錄代碼倉庫即可。

10.【參考】對于注釋的要求：第一、能夠準(zhǔn)確反映設(shè)計思想和代碼邏輯；第二、能夠描述業(yè)務(wù)含義，使別的程序員能夠迅速了解到代碼背后的信息。完全沒有注釋的大段代碼對于閱讀者形同天書，注釋是給自己看的，即使隔很長時間，也能清晰理解當(dāng)時的思路；注釋也是給繼任者看的，使其能夠快速接替自己的工作。

11.【參考】好的命名、代碼結(jié)構(gòu)是自解釋的，注釋力求精簡準(zhǔn)確、表達(dá)到位。避免出現(xiàn)注釋的一個極端：過多過濫的注釋，代碼的邏輯一旦修改，修改注釋又是相當(dāng)大的負(fù)擔(dān)。

• 反例：

// put elephant into fridge 
put(elephant, fridge);

方法名 put，加上兩個有意義的變量名 elephant 和 fridge，已經(jīng)說明了這是在干什么，語義清晰的代碼不需要額外的注釋。

12.【參考】特殊注釋標(biāo)記，請注明標(biāo)記人與標(biāo)記時間。注意及時處理這些標(biāo)記，通過標(biāo)記掃描，經(jīng)常清理此類標(biāo)記。線上故障有時候就是來源于這些標(biāo)記處的代碼。

1） 待辦事宜（TODO）:（標(biāo)記人，標(biāo)記時間，[預(yù)計處理時間]）表示需要實現(xiàn)，但目前還未實現(xiàn)的功能。這實際上是一個 Javadoc 的標(biāo)簽，目前的 Javadoc 還沒有實現(xiàn)，但已經(jīng)被廣泛使用。只能應(yīng)用于類，接口和方法（因為它是一個 Javadoc 標(biāo)簽）。

2） 錯誤，不能工作（FIXME）:（標(biāo)記人，標(biāo)記時間，[預(yù)計處理時間]）在注釋中用 FIXME 標(biāo)記某代碼是錯誤的，而且不能工作，需要及時糾正的情況。