本文借鉴学习https://blog.csdn.net/qq_32168785/article/details/109670547
一、安装javaDoc插件
File->Settings->Plugins
搜索javaDoc ,点击 install按钮安装。重启AS,即可以使用javaDoc。
二、添加类注释
添加类注释实质上是添加类模板
方法:
File–>settings–>Editor–>File and Code Templates–>Files–>Class
在模板上加入文档注释模板
/**
*@ClassName ${NAME}
*@Description TODO
*@Author ${USER}
*@DATE ${DATE} ${TIME}
*@Version 1.0
*/
三、在方法上生成文档注释
1、File–>Settings–>Editor–>Live Templates
2、单击右侧“+”号,选择Template Group…,新建一个自定义模板组,可以使用自己的名字命名;
3、选择该模板组,单击右侧“+”号,选择“Live TempLate”,设置“abbreviation”的值为”*”;
4、设置模板内容,选择Temple Text,设置为
*
* @Author $user$
* @Description //TODO
* @Date $time$ $date$
* @Param $param$
* @return $return$
**/
5、设置该模板在哪些文件生效,选择下方的define-everywhere-java,设置只在java文件中生效
6、选择右侧的Edit variables按钮,进行如下配置
7、使用/*+刚设置的模板名(此处为我们前面设置的“ * ”)+tab(默认模板补全快捷键,在上方的“By default expand with”设置,此处我更改为了Enter,看个人习惯),所以此时我们使用/** + tab就能补全,效果如下
本文借鉴学习https://blog.csdn.net/qq_32168785/article/details/109670547