Android Studio快速添加註釋及註釋規約

類註釋

找到下面的路徑：File —— Settings —— Editor —— File and Code Templates —— includes —— File Header，輸入自定義的註釋內容，保存後，新創建類時就會自動添加自定義的註釋，添加Activity之類文件的話不會自動生成，不過可以使用自定義註釋模板的方法。

如果註釋的標籤沒有使用過，會高亮顯示，警告“Wrong tag”，根據提示，光標放到標籤上按Alt + Shift + Enter即可添加自定義標籤，下次再用到時就不會出現警告了。

方法註釋

在方法的上面輸入/** + Enter 即可自動生成方法註釋。

自定義註釋模板

找到下面的路徑：File —— Settings —— Editor —— Live Templates，如果之前沒創建過模板，點擊右側的+，先添加模板組，然後選中模板組之後再點+，添加動態模板。這裏的模板可用作文件註釋、方法註釋等等。

在Abbreviation處設置自動註釋的縮寫，使用時，輸入此縮寫+enter即可添加註釋模板（例如這裏設置的縮寫是file，那麼需要添加註釋時，輸入file+Enter即可自動添加），點擊下方的change設置註釋可以生效的區域。

點擊右側的Edit variables設置標籤的值，設置的值在添加註釋時會自動生成。

使用JavaDoc插件註釋

找到下面的路徑：File —— Settings —— Plugins，下載JavaDoc插件。

使用JavaDoc插件添加註釋有下面幾種方式：

1. 使用快捷鍵，選中需要註釋的元素，Alt+Shift+G爲當前元素添加註釋，Ctrl+Alt+Shift+G爲所有元素添加註釋，Alt+Shift+Z移除當前元素註釋，Ctrl+Alt+Shift+Z移除所有註釋。
2. 選中需要註釋的元素，按Alt+Enter，選擇Add Javadoc，爲當前元素添加註釋。
   
3. 右鍵需要註釋的元素，點擊Generate（或直接使用快捷鍵Alt+Insert），選擇添加註釋。
   
4. 右鍵類文件，找到JavaDocs——Create JavaDocs for all elements，可以爲所有類、方法、全局變量等添加註釋。
   

使用JavaDoc插件生成API文檔

找到下面的路徑：Tools —— Generate JavaDoc，設置完需要生成的文件（如果只需要生成當前文件的文檔，則可以將Custom scope設置爲Current File）和文檔輸出目錄後，點OK即可生成文檔。

找到文檔輸出目錄，打開index.html即可查看文檔。

註釋規約

良好的代碼註釋有利於代碼閱讀，應遵循一定的規範，以下注釋規約來自阿里巴巴，可做參考：

☝ ★★★ — 返回 《Android開發筆記彙總》總目錄 — ★★★ ☝