插件的安装

File → Settings → Plugins → Browse repositories然后搜索Javadoc,然后点击install并重启androidstudio就ok了。

配置模板

File-settings-other settings-JavaDoc进行配置


然后点击某个选项进配置

我这儿拿method的来举例。我给每个方法的注解加 一个 作者以及时间

@author 搬运工小孟 Created on ${.now?string["yyyy-MM-dd"]} \n



也可以根据需求来进行修改。

使用

把鼠标移动到方法中,然后shift + alt + G

如果是对这个类所有的方法都进行注释,就是shift + ctrl + alt + G

也可以通过alt+insert来进行选择。

shift + alt + Z是撤销当前/选择

shift + ctrl + alt + Z是撤销所有注释。

生成JavaDoc文档

对于androidlibrary来说,如果生成JavaDoc文档建议删掉build文件以及测试文件。

打开Tools--->Generate JavaDoc

因为很多文件会是UTF-8的编码格式,所以建议加上

-encoding utf-8 -charset utf-8



最后点击ok就能生成对应的javadoc文档了,然后打开文档里面的index.html就对了。



最后想说的的是:对于javadoc的注解这个想了解更多的可以参考github开源地址:

https://github.com/setial/intellij-javadocs

也可以加群了解:

群号:490832714

谢谢所有开源的开发人员。



更多相关文章

  1. keytool 生成 Android(安卓)SSL 使用的 BKS
  2. Android技术周报_W2_2017年01月15日
  3. Base64方式上传文件
  4. Android使用marked.js渲染markdown文档
  5. 安卓开发学习之解决JS不能调用Android方法
  6. 使用 Annotation 改善 Android(安卓)代码
  7. 解决android sdk docs帮助文档打开慢的问题
  8. Android(安卓)6.0 通话记录生成保存和读取显示
  9. Android(安卓)Studio AIDL创建案例(解决自动生成java问题)

随机推荐

  1. Android(安卓)XML解析学习——Pull方式
  2. 转:一个Demo学完Android中所有的服务
  3. 转:关于android多任务同时下载的一点心得
  4. [置顶] 我的Android进阶之旅------>关于a
  5. 开发android应该注意的
  6. Android情侣短信软件(1)--Frame动画在悬浮
  7. android 使用Photoshop获取图片某一点的
  8. Android(安卓)Studio + Eclipse 实现类似
  9. Docker+Appium实现同时在多台手机上进行A
  10. 解决 Android(安卓)Studio 创建项目时极