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开发笔记汇总》总目录 — ★★★ ☝