Eclipse自动生成文件注释以及使用javadoc命令自动生成API文档

首先打开Eclipse编辑器,然后找到Window下的Preferences选项,点击打开它。然后按照图示操作。

Eclipse自动生成文件注释以及使用javadoc命令自动生成API文档_第1张图片

Eclipse自动生成文件注释以及使用javadoc命令自动生成API文档_第2张图片

Eclipse自动生成文件注释以及使用javadoc命令自动生成API文档_第3张图片

打开到这个界面的时候,先选中New Java files,然后点击右边的Edit。将你想要自定义注释的内容填入Pattern中,下面注释为本人个人电脑使用注释。

${filecomment}
${package_declaration}
/**
* 这是文档注释
* @author 作者
* @version 创建时间:${date} ${time}
*/
${typecomment}
${type_declaration}

Eclipse自动生成文件注释以及使用javadoc命令自动生成API文档_第4张图片

最后选中AutoMatically add comments for new methods and types,不过我没有选中该项,但是依然可以正常使用。

然后点击Apply最后点击OK。


自定义注释使用完了之后,我们可以使用javadoc命令自动生成API文档。

首先找到你创建的java项目,鼠标右击该项目,弹出该窗口,依次选中Show In,然后左击System Exploer这一项。

Eclipse自动生成文件注释以及使用javadoc命令自动生成API文档_第5张图片


然后找到对应硬盘上的java文件Test.java


之后在该目录下空白处,按住键盘shift键不放右击空白处弹出该窗口,点击在此处打开命令窗口。

Eclipse自动生成文件注释以及使用javadoc命令自动生成API文档_第6张图片

打开之后输入javac "自己项目里的java文件名",此处使用Test.java,编译过该文件之后。

Eclipse自动生成文件注释以及使用javadoc命令自动生成API文档_第7张图片

输入命令javadoc "自己项目里的java文件名"。运行之后

Eclipse自动生成文件注释以及使用javadoc命令自动生成API文档_第8张图片

找到目录下的index.html,打开它,文档就已经生成好了。

Eclipse自动生成文件注释以及使用javadoc命令自动生成API文档_第9张图片

你可能感兴趣的:(java实用技巧)