Java注释详解-Java文档注释生成Java API文档

来源：互联网发布：电影制作软件编辑：程序博客网时间：2024/05/16 10:29

Java文档注释是一种功能强大的注释形式，如果在你所编写的程序中规范的添加文档注释，那你就可以生成一份系统正规的API文档。Java文档注释 /**文档注释内容*/,注意区分多行注释/*多行注释*/。

Eclipse怎么生成API帮助文档呢，

方法有三：

方法一：选择工程，在菜单Project->Genarate Javadoc

方法二：选择工程，鼠标右键菜单Export ，选择Java 下面的Javadoc ，点”next” 按钮

方法三：选择工程，在菜单File->Export ，选择Java 下面的Javadoc ，点”next” 按钮

操作都一样我们以方法一为例：

Eclipse生成API帮助文档(图文详解)

在Eclipse新建一个项目test，包结构如下：

我为项目中的这三个类TestJavaDoc ，JavaBoc， TestJavadoc2添加了文档注释，类的源码如下：

01package com.qiice.jboring;
02/**
03 *Description:这是文档注释测试
04 *Copyrigth(C),2012,奇冰网qiice.com
05 *Program:Test Javadoc
06 *Date:2012.6.28
07 *@author Jboring
08 *@version 1.0
09 * */
10public classTestJavaDoc {
11    /**
12     * 属性测试
13     * */
14    publicintage;
15    /**
16     * 无参构造器测试
17     * */
18    publicTestJavaDoc(){}
19    /**
20     * 有参构造器测试
21     * */
22    publicTestJavaDoc(intage){
23        this.age=age;
24    }
25    /**
26     * 程序入口，主方法
27     * */
28    publicstaticvoid main(String[] args){
29        System.out.println("Hello qiice.com");
30    }
31 
32}

01package com.qiice.test;
02/**
03 *Description:这是文档注释测试
04 *Copyrigth(C),2012,奇冰网qiice.com
05 *Program:Test Javadoc
06 *Date:2012.6.28
07 *@author Jboring
08 *@version 1.1
09 * */
10public classJavaDoc {
11    /**
12     * 属性测试
13     * */
14    publicintage;
15    /**
16     * 无参构造器测试
17     * */
18    publicJavaDoc(){}
19    /**
20     * 有参构造器测试
21     * */
22    publicJavaDoc(intage){
23        this.age=age;
24    }
25    /**
26     * 程序入口，主方法
27     * */
28    publicstaticvoid main(String[] args){
29        System.out.println("Hello qiice.com");
30    }
31 
32}

01package com.qiice.test;
02/**
03 *Description:这是文档注释测试
04 *Copyrigth(C),2012,奇冰网qiice.com
05 *Program:Test Javadoc
06 *Date:2012.6.28
07 *@author Jboring
08 *@version 1.1
09 * */
10public classTestJavadoc2 {
11    /**
12     * 显示今年多大年龄的方法
13     * @param age 参数指定年龄
14     * @return 返回今年多少岁字符串
15     * */
16    publicString age(intage){
17        return"我今年"+age+"岁。";
18         
19    }
20 
21}