Android(安卓)studio JavaDoc的使用
16lz
2021-01-26
插件的安装
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
谢谢所有开源的开发人员。
更多相关文章
- keytool 生成 Android(安卓)SSL 使用的 BKS
- Android技术周报_W2_2017年01月15日
- Base64方式上传文件
- Android使用marked.js渲染markdown文档
- 安卓开发学习之解决JS不能调用Android方法
- 使用 Annotation 改善 Android(安卓)代码
- 解决android sdk docs帮助文档打开慢的问题
- Android(安卓)6.0 通话记录生成保存和读取显示
- Android(安卓)Studio AIDL创建案例(解决自动生成java问题)