1. Android studio 使用 JavaDoc
1.1. 安装 JavaDoc 插件
Preference > Plugins > Browse repositories > 搜索 javadoc > Install
1.2. 写注释
tag
@author (classes and interfaces only, required)
@version (classes and interfaces only, required. See footnote 1)
@param (methods and constructors only)
@return (methods only)
@exception (@throws is a synonym added in Javadoc 1.2)
@see
@since
@serial (or @serialField or @serialData)
@deprecated (see How and When To Deprecate APIs)
1.3. 使用 JavaDoc 插件
Preference > Keymap > Plug-ins > JavaDoc 查看 javadoc 快捷键
- 对一个元素注释：把鼠标移动到元素中，然后
shift + alt + G或者shift + option + G。 - 对所有方法元素注释：
shift + alt ctrl + + G或者shift + option + control + G - 撤销当前/选择：
shift + alt + Z或者shift + option + Z - 撤销所有注释：
shift + alt + ctrl + Z或者shift + option + control + G
1.4. 生成 JavaDoc 文档
Tools > Generate JavaDoc
Output directory输出文档目录Other Command line arguments:设为-encoding utf-8 -charset utf-8