Android studio使用javadoc生成 api 说明文档

文章目录

• 1、工具下载
• 2、实用工具添加注释
• 3、使用该工具生成api 文档
• 4、查看生成的api 文档
• 5、帮助

1、工具下载

2、实用工具添加注释

官方wiki

To generate javadocs for active element press “shift + alt + G”.
To generate javadocs for all elements in current java file press “shift + ctrl + alt + G”.

shift + alt + G 生成指定方法的注释
shift + ctrl + alt + G 生成全部注释 private 函数除外

Remove javadocs on current/selected element: “shift + alt + Z”
Remove javadocs on all elements of current class: “shift + ctrl + alt + Z”

shift + alt + Z 去掉指定方法的注释
shift + ctrl + alt + Z 去掉去拿不方法的注释

3、使用该工具生成api 文档

4、查看生成的api 文档

5、帮助

更多信息可以在命令框输入 javadoc -help 进行查看