android studio文档javadoc的编写以及自定义注释模版

发布时间:2020-06-24 21:17:26 作者:whatever957
来源:网络 阅读:5429


(一)通常javadoc模版注释产生方法:

在函数名上面一行输入/**<Enter>,自动会生成如下注释格式:

/**

*这里可以简单介绍函数功能

*@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就可以生成了。


如果想自定义注释模版,参考下文:

http://www.jb51.net/article/69923.htm

即:

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完成。




推荐阅读:
  1. android studio中常用快捷键
  2. Android 打包成jar类库 和 doc文档输出

免责声明:本站发布的内容(图片、视频和文字)以原创、转载和分享为主,文章观点不代表本网站立场,如果涉及侵权请联系站长邮箱:is@yisu.com进行举报,并提供相关证据,一经查实,将立刻删除涉嫌侵权内容。

studio android javadoc

上一篇:elasticsearch.yml基本配置说明

下一篇:java运算符中的“--”怎么用

相关阅读

您好,登录后才能下订单哦!

密码登录
登录注册
其他方式登录
点击 登录注册 即表示同意《亿速云用户服务条款》