对文档注释的使用

java SE 文档注释的简单使用

首先,这里是想要生成一个类的帮助文档,在包资源管理器中选选中这个类,鼠标右键点击,找到导出,点击。

选择java文件夹下的javadoc,然后下一步。

java SE 文档注释的简单使用

接下来的这一步是找你需要保存的位置,由于我之前导出过,所以上边是提示有,但是可以覆盖,所以这时点击“完成”。

控制台会提示已经生成完毕。

java SE 文档注释的简单使用

java SE 文档注释的简单使用

接下来就是查看这个DOC文件到底是什么样的。

找到导航器

java SE 文档注释的简单使用

在导航器中,找到DOC文件夹,其中的index.html  使用web 打开。

java SE 文档注释的简单使用

这时,自动生成的帮助文档就和API是相同的版式了。

java SE 文档注释的简单使用






相关文章: