Android开发：JavaDoc注释插件简单使用介绍

Posted 2020-12-14 wi100sh

原文网址：https://www.jianshu.com/p/06153fabcad3

一、插件说明

JavaDoc

添加注释，可自定义模板。
插件下载地址：https://plugins.jetbrains.com/plugin/?idea_ce&pluginId=7157
插件源码地址：https://github.com/setial/intellij-javadocs
推荐指数： 五星

二、插件安装

android Studio: File → Settings → Plugins → Browse repositories 搜索插件名【JavaDoc】 并安装
或者
Android Studio: 下载jar文件 并安装
　　 File → Settings → Plugins → Install plugin from disk (选本地插件包)安装即可。

三、插件使用

1、注释快捷键

Windows电脑：在方法上面输入快捷键 alt+ctrl+shift+G 即可自动生成注释，或者按alt+insert调出对话框，手动选择。
Mac电脑：在方法上面输入快捷键 alt+command+shift+G 即可自动生成注释，或者按command+N调出对话框，手动选择。

 

command_N.png

2、生成javadoc文档

在Android studio中进行打开一个项目的文件之后，然后进行点击Android stuio中菜单中的“tools”的选项。

 

Tools.png

这样就会弹出了下拉菜单中，进行选中下拉菜单中的“generate javadoc”的选项。

 

Generate JavaDoc.png

就会弹出了specify generate javadoc scope的窗口，在output directorys中进行输出的路径。

 

OutputPath.png

可在运行的窗口中查看到的是文件正在生成，根据文件大小，对生成的时间上等待。

 

progress.png

文件生成完毕之后，进入到了resource的文件，进行双击index.html的选项即可。

 

index.png

这样就同index.html中查看代码中所有类的方法，如果有添加注释的信息，也可查看到。

 

javadoc.png

四、小技巧

1、解决使用Android Studio导出JavaDoc时中文乱码问题

导出过程中，在Other command line arguments栏目添加命令参数：

-encoding UTF-8 -charset UTF-8（如果是GBK，参数为 -encoding GBK -charset GBK）

默认是中文文档，添加 -locale en_US 生成英文文档

或者在Locate栏目添加 en_US

2、command+J：调出系统注释选择项

 

system_ annotation.png

3、类注释代码

/** 
 * @Author: ${USER}
 * @Time: ${DATE} ${TIME}
 * @Company：公司名称
 * @Description: 功能描述
 */

 

File Header.png

4、类似主题优秀文档参考

https://blog.csdn.net/EthanCo/article/details/52003296

作者：Jason_hzb
链接：https://www.jianshu.com/p/06153fabcad3
来源：简书
著作权归作者所有。商业转载请联系作者获得授权，非商业转载请注明出处。