(一)通常javadoc模版注释产生方法:
在函数名上面一行输入/**,自动会生成如下注释格式:
/**
*这里可以简单介绍函数功能
*@param
*@param
*@return
*/
(二)生成javadoc:
点击android studio菜单栏Tools->Generate JavaDoc->选择Whole project或者Custom scope->选择Output directory作为javadoc生成位置->OK。
注:若提示编码错误,则在Other command line arguments中输入:-encoding utf-8 -charset utf-8
按照以上方法,基本的javadoc就可以生成了。
如果想自定义注释模版,参考下文:
即:
1.File->Setting->Editor->Live Templates
2.点击+,创建一个Template Group,输入group名字
3.选中你刚刚创建的group,创建Live Template
4.填写Abbreviation,我这里填的是cmt,也即你这个注释的快捷方式,你敲cmt加回车,模板就出来了
Template text是注释的模板,具体你模板要怎么写都可以,我的模板如下:
/*** 〈一句话功能简述〉* 〈功能详细描述〉*@param[参数1] [参数1说明]*@param[参数2] [参数2说明]*@return[返回类型说明]*@exception/throws[违例类型] [违例说明]*@see[类、类#方法、类#成员]*/
5.要设置你这个cmt快捷键在哪里生效,我的选择是在声明(Java-Declaration)的时候生效,也即你在方法名上打cmt加回车就可以了
6.点击Apply完成。