版权声明：本文为博主原创文章，未经博主允许不得转载。 https://blog.csdn.net/sinat_32197439/article/details/82668692
如何使用eclipse生成javaDoc
- 生成package-info.java
- 新建包的时候勾选左下方的框框 将对文档的描述写入此文件中，具体的注解等尚未深究
- 右键选择项目Export,选择javadoc
- javadoc commond，选择路径为 jdk/bin/javadoc.exe
- destintion 选择导出的位置 由自己选择
- 最后一步 在vm options中写入防止gbk编码问题
-encoding utf-8 -charset utf-8
- 到生成javadoc的地方打开浏览器即可看到效果
javadoc的规范
- 1.参考jdk源码内的文档规范
- 2.参考effective java中对此的解读
- 简洁易读
- 参数，返回值
- 前置条件，后置条件，副作用
- 线程安全
- 序列化性
- 允许html 但是需要转义