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

/**
 * Title: Person类

 * Description:通过Person类说明Java中的文档注释

 * 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