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

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

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

方法有三：

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

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

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

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

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

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

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

01 package 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  * */ 10 public class TestJavaDoc { 11     /** 12      * 属性测试 13      * */ 14     public int age; 15     /** 16      * 无参构造器测试 17      * */ 18     public TestJavaDoc(){} 19     /** 20      * 有参构造器测试 21      * */ 22     public TestJavaDoc(int age){ 23         this.age=age; 24     } 25     /** 26      * 程序入口，主方法 27      * */ 28     public static void main(String[] args){ 29         System.out.println("Hello qiice.com"); 30     } 31   32 }

01 package 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  * */ 10 public class JavaDoc { 11     /** 12      * 属性测试 13      * */ 14     public int age; 15     /** 16      * 无参构造器测试 17      * */ 18     public JavaDoc(){} 19     /** 20      * 有参构造器测试 21      * */ 22     public JavaDoc(int age){ 23         this.age=age; 24     } 25     /** 26      * 程序入口，主方法 27      * */ 28     public static void main(String[] args){ 29         System.out.println("Hello qiice.com"); 30     } 31   32 }

01 package 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  * */ 10 public class TestJavadoc2 { 11     /** 12      * 显示今年多大年龄的方法 13      * @param age 参数指定年龄 14      * @return 返回今年多少岁字符串 15      * */ 16     public String age(int age){ 17         return "我今年"+age+"岁。"; 18           19     } 20   21 }

 

我们使用的Ecplise来生成这个项目test的API文档

选中要生成API项目test 然后Project->Genarate Javadoc 如下图：

点击进入

这里要说一下API文档是给别人查看使用的，一些不想暴露的地方就不必显示，

Create Javadoc for members with visibility: 就是让你选择范围 private ，package ，protect ，public 。一般Javadoc 工具默认处理protect 或者public修饰的类，方法，属性等前面的注释。

 

Use standard doclet 选择生成的路径，我选择在桌面api文件夹内。

 

点击Next，进入如下图：

Document title是设置概述页面的标题

点击Finish就开始生成API了，点击生成的index.html页面就能看到生成的API了

我生成的API： 点击打开生成的API。

 

常用的javadoc标记如下：

@author：指定java程序作者。可以出现在类或者接口文档注释中。

@version:程序版本。可以出现在类或者接口文档注释中。

@deprecated:不推荐使用的方法。可以出现在类，接口，方法，构造器，属性注释文档中。

@return:方法返回值的说明。可以出现在方法，构造器注释。

@see:指定参考内容。可以出现在类，接口，方法，构造器，属性注释文档中。

@exception:抛出异常类型。可以出现在方法，构造器注释文档中。

@throws:和exception同义，抛出异常.可以出现在方法，构造器注释文档中。

 

给你写的Java程序加上注释文档是不是感觉写的程序更酷了，你可以平时添加适当的文档注释，来熟悉熟练使用标记。关于javadoc感兴趣可以深入研究一下，还是有很多东西的。

版权所有奇冰网：转载请注明出处
本文链接：http://www.qiice.com/shujuleixing/JavaAPI2.html
关键字：注释|