前言
因为看到了《阿里巴巴Java开发手册(华山版)》,所以在Eclipse和IDEA中安装了相应的插件,分别是Javadoc和阿里巴巴编码规约扫描。
1. Eclipse
- p3c
- 安装
Eclipse安装p3c和普通的插件安装一样,这里是阿里巴巴GitHub链接:
https://github.com/alibaba/p3c/tree/master/eclipse-plugin。 按照上面的步骤完全可以安装成功。 - 测试
安装完成后需要重启。
编写一个简单代码测试: - 运行阿里巴巴编码规约扫描:
右键 -> 阿里巴巴编码规约扫描 - 可以看到扫描结果:
- 第一个问题是类名,这里将P3CTesting修改位P3cTesting。
第二个问题是没有添加类的注释信息,添加即可(博主已经配置了注释模板)。
再次扫描:
- Javadoc
Javadoc不用安装,直接使用即可。
点击Project -> Generate Javadoc
配置如下:
第一个框选择自己已经安装的JDK目录下的javadoc.exe。
第二个框选择自己要使用的类,可以选择整个项目,博主这里只选择刚才写的类。
第三个框生成doc文件的目录,默认选项。
点击Next:
选择:
点击Next,设置编码格式:
-encoding UTF-8 -charset UTF-8
点击Finish:
项目目录下会生成doc目录,浏览器打开index.html:
结果(有没有感觉网页排版在哪里见过,哈哈。):
2. IDEA
IDEA使用插件安装即可:
File -> Settings -> Plugins
分别搜索安装JavaDoc 和 Alibaba
安装完成后需要重启。。。
测试
创建一个Java项目:
右键运行编码规约扫描:
运行结果:
可以看到与Eclipse中的检测结果一致。修改类名,和添加注释后,再次扫描:
左下方提示没有发现可以代码。。。
生成Javadoc:
Tools -> Generate JavaDoc
设置参数:
结果:
查看:
完!