如何生成java api document 相似的文档帮助(1)

1.  综述
java 的文档注释功能： 在编写java源文件时候，使用
/**
@author: 指定Java程序的作者
@version: 指定源文件的版本
@param: 方法参数的说明信息
@return: 方法的返回值说明信息
@exception: 抛出异常的类型
@throws: 抛出的异常， 与@exception同义
*/

定义注释，就可以使用JDK提供的javadoc工具直接将源代码里的文档注释提取成一份系统的API文档。

2. 代码举例如下：

点击(此处)折叠或打开

1. package com.std.crazy.dtnum;
   
2. /**
   
3.  *
   
4.  * @author david
   
5.  * <br/>website: <a href="http://www.***.org">crazy Java bind</>
   
6.  * <br/>Copyright (C),2001-2012,
   
7.  * <br/>This programs is protected by copyright david
   
8.  * @version 1.0
   
9.  */
   
10. public class Student {
    
11. 
    
12.     /**
    
13.      * the name attribute
    
14.      */
    
15.     public String name;
    
16.     /**
    
17.      * the protected attribute of age
    
18.      */
    
19.     protected int age;
    
20.     public String getName() {
    
21.         return name;
    
22.     }
    
23.     /**
    
24.      * set the name of student
    
25.      * @param name the pointed name
    
26.      */
    
27.     public void setName(String name) {
    
28.         this.name = name;
    
29.     }
    
30.     /**
    
31.      * get the age of student
    
32.      * @return the age of this student
    
33.      */
    
34.     public int getAge() {
    
35.         return age;
    
36.     }
    
37.     public void setAge(int age) {
    
38.         this.age = age;
    
39.     }
    
40. }

3. 运行javadoc命令如下

 切换到java 源文件所在目录  cd F:\kq\java_ecli_workspaces\workspaces\Bach\Crazy_Java\src\com\std\crazy\dtnum
    dir
    2016-09-11  09:43               757 Student.java
 
 javadoc -d F:\快钱\java_ecli_workspaces\apidoc -windowtitle 学生管理系统 javadoc 学生管理API文档 -header 我的类 -version -author

4. 运行结果
会生成一组html文件， 


生成的API到此结束，下一篇将会掩饰对多个包生成API文档。

我们在开发中多使用/** */的注释，可以自动生成api-doc文件，那么可以很好的进程程序的开发对接。

来自 “ ITPUB博客 ” ，链接：http://blog.itpub.net/674865/viewspace-2124795/，如需转载，请注明出处，否则将追究法律责任。

转载于:http://blog.itpub.net/674865/viewspace-2124795/