Android studio JavaDoc的使用
2016-05-25 16:43
405 查看
插件的安装
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
谢谢所有开源的开发人员。
相关文章推荐
- Android之Adapter用法总结
- Android AudioManager类(必看)
- view坐标_ _ Android应用坐标系统全面详解
- Android drawable文件使用(一)layer-list
- AsyncTask 坑 (二) AsyncTask对象生命周期
- 关于Android中设置闹钟的相对完善的解决方案
- android listview与adapter用法
- 详解Android TabHost的多种实现方法 附源码下载
- Android 自定义View 让内容跟随手指滚动
- Android的拍照功能
- Android端 WebP图片压缩与传输的一点探索
- Android设计中如何切图.9.png(点9图)
- android KTV 开发(一)自定义videoView 实现视频大小自由缩放、全屏与预览
- android刷新媒体库
- android二维码扫描、读取、识别、生成、带logo
- Android中Style和Theme的使用
- android 处理程序全局异常和错误,UncaughtExceptionHandler
- Android Studio自动检查代码规范并提示如何优化的一些插件
- Android中修改默认字体的大小----fontScale
- android listview判断上滑还是下滑