首页 诗词 字典 板报 句子 名言 友答 励志 学校 网站地图
当前位置: 首页 > 教程频道 > 开发语言 > 编程 >

结构自己的API,javadoc生成文档注释

2012-10-12 
构造自己的API,javadoc生成文档注释,由于文档注释是用于生成API文档的,而API文档主要用于说明类,方法,属性

构造自己的API,javadoc生成文档注释,
   由于文档注释是用于生成API文档的,而API文档主要用于说明类,方法,属性的功能。因此javadoc工具只处理文档源文件在类、接口、方法、属性、构造器和内部类之前的注释,忽略其他地方的文档注释。而且javadoc工具默认只处理以public和protected修饰的类、接口、方法、属性、构造器之前的文档注释。
    文档注释以斜线后紧跟两个星号开始(/**),以星号后紧跟一个斜线(*/)作为结尾,中间部分全部都是文档注释,会被提取到API文档中。
    特别注意,一定要对处于多个包下的源文件来生成API文档时,才有概述页面
    具体如下:

第一个测试类:
package lee;
/**
*Description:
*<br/>Copyright (c),2005-2008,Yeeku.H.lee
<br/>This program is protected by copyright laws;
*<br/>Program Name:
*<br/>Dte:
*@author Yeeku.H.Lee kongyeeku@163.com
*@version 1.0
*/
public class TestJavadoc{
    /**
    *简单测试属性
    */
    protected String name;
    /**
    *主方法,程序的入口
    */
    public static void main(String[] args){
        System.out.println("Hello World!");
    }
}
第二个测试类:

package yeeku;
/**
*Description:
*<br/>Copyright (c),2005-2008,Yeeku.H.lee
<br/>This program is protected by copyright laws;
*<br/>Program Name:
*<br/>Dte:
*@author Yeeku.H.Lee kongyeeku@163.com
*@version 1.0
*/
public class Test{
     /**
     *简单测试属性
     */
     public int age;
     /**
     *Test类的测试构造器
     */
     public Test(){
     }
    
}
javadoc命令的基本用法如下:
javadoc 选项  java源文件/包。
javadoc命令可对源文件,包来生成API文档,在上面的预防格式中,java源文件可以支持通配符,例如使用*.java来代表当前路径下所有java源文件。javadoc的常用选项如下:
-d <directory>: 该选项指定一个路径,用于将生成的API文档放到指定目录下。
-windowtitle <text>:该选项指定一个字符串,用于设置API文档的浏览器窗口标题。
doctitle <html-code>:该选项指定一个HTML格式的文本,用于指定概述页面标题。
-header <html-code>:该选项指定一个HTML格式的文本,包含每个页面的页眉。
命令行窗口执行以上两个java程序生成API文档:
javadoc -d  apidoc -windowtitle 测试 -doctitle 学习javadoc -header 自定义类Test *.java

    

热点排行