Java的文档注释之生成帮助文档的实例

示例：

/**
 * Title: Person类<br/>
 * Description:通过Person类说明Java中的文档注释<br/>
 * Company: ***
 * @author ***
 * @version 1.0
 */
public class Person {
 /**
 * 这个是Person类的构造方法
 * @param name Person 的名字
 * */
 public Person(String name) {
 //执行语句；
 }
 /**
 * 这是read（）方法说明
 * @param bookName 读的书的名字
 * @param time 读书所用的时间
 * @return 读的书的数量
 * */
 public int read(String bookName, int time) {
 //执行语句；
 return 1;
 }
}

生成命令

person Mac$ javadoc -d . -version -author Person.java

注意Person.java路径名要正确。

效果：

其中index.html为主页，打开如下图：

以上这篇Java的文档注释之生成帮助文档的实例就是小编分享给大家的全部内容了，希望能给大家一个参考，也希望大家多多支持服务器之家。

原文链接：http://www.cnblogs.com/gdwkong/archive/2017/12/13/8034998.html