javaDoc 文档注释
分类:
文章
•
2022-11-07 00:26:52
-
创建java源文件包，普通的java package。java文件都是存放在一个package包中，这样方便对java文件进行操作和区分，首先在磁盘上创建文件夹一样的方式创建package包。
-
创建java源文件。在包下，创建与文件名相同的java源文件，输入一些文档注释，这些文档注释用于自动的api文件进行说明使用。注意从现在开始就需要编写好各种代码注释。
-
进入java源文件目录。通过cd等windows命令进入java源文件包所在的磁盘位置。可以在项目上右键查看到对应的磁盘目录，然后在目录下安装shift+右键就可以看到命令。
-
查看javadoc命令使用说明。如果是第一次使用javadoc命令，可以通过javadoc -help命令查看javadoc使用说明。也可以直接在网上搜索对应的java命令
-
开始创建api文件。使用命令输入javadoc -d javaapi -header 测试的API -doctitle 这是我的第一个文档注释 -version -author javadoc/Hello.java 进行文档生成。-d:文件存储位置; -head:文件头部名称; -version:显示版本; -author:显示作者; javadoc/Hello.java 处理的文件包以及java源文件.
-
查看生成的api文件。创建成功之后，就会自动创建指定的文件夹下生成api文件。打开index.html就是api文件的入口，可查看自己编写的代码生成的api文档。
