JavaDoc是一种将注释生成HTML文档的技术。
1、使用javadoc命令生成文档
首先了解一下javadoc指令的用法
用法: javadoc [options] [packagenames] [sourcefiles] [@files]
使用指令生成文档,这里的java文件的编码是utf-8,所以要带上编码选项 -encoding utf-8
指令 javadoc -encoding utf-8 Fish.java
打开index.html文件
使用eclipse生成文档
选中java文件,右键选择Export,进入Export界面,选Java-Javadoc
点击Next,选中目录
两次一直选择Next,配置VM options指定源文件编码为 -encoding utf-8 , 点击Finsh
查看生成文档过程的信息与文档
3、 Intellij Idea生成JavaDoc
JavaDoc是一种将注释生成HTML文档的技术,生成的HTML文档类似于Java的API,易读且清晰明了。在简略介绍JavaDoc写法之后,再看一下在Intellij Idea 中如何将代码中的注释生成HTML文档。
先看一段样例代码: