Java doc的介绍

Java doc的介绍

1、什么是javadoc,有什么用？

javadoc是一个jdk内置的命令工具，用来根据源代码生成对应的说明文档，包、类、方法以及对应的注释一目了然，定义了一套代码书写规范，列如可以看jdk自己的javadoc文档

2、如何使用？

1）idea插件 tools -> Generate java docs
2) 命令的方式
可以通过javadoc -help查看具体的命令
列如
javadoc -d ./doc -sourcepath ./src/main/java -subpackages com.hzl -private -author -version -encoding utf-8 -charset utf-8 -windowtitle 自定义API文档 -doctitle 学习如何使用javadoc编写api文档 -header 生成API文档的测试类

其中sourcepath要定位至顶级包名的上一文件夹
-author -version 表示要显示作家和版本

3、遵循的规范

1）先写注释内容，再写author、since、see