码迷,mamicode.com
首页 > 编程语言 > 详细

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

时间:2017-12-14 03:43:18      阅读:181      评论:0      收藏:0      [点我收藏+]

标签:person   帮助文档   ***   示例   log   执行   read   esc   int   

示例:

/**
 * 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的文档注释之生成帮助文档

标签:person   帮助文档   ***   示例   log   执行   read   esc   int   

原文地址:http://www.cnblogs.com/gdwkong/p/8034998.html

(0)
(0)
   
举报
评论 一句话评论(0
登录后才能评论!
© 2014 mamicode.com 版权所有  联系我们:gaon5@hotmail.com
迷上了代码!