javadoc 工具生成开发API文档
=====================先来一点成就感=====================
1 package com.springMybatis.dao; 2 3 import com.springMybatis.model.*; 4 5 6 /** 7 * AuthorizationDao 定义Authorization接口 8 * @author g.qu 9 * @see java.lang 10 */ 11 public interface AuthorizationDao{ 12 13 /** 14 * addAuthorization 添加授权 15 * @param authorization 授权对象 16 * @return 布尔值 true 成功;false 失败 17 */ 18 public boolean addAuthorization(Authorization authorization); 19 20 /** 21 * deleteAuthorization 删除授权 22 * @param authorization 授权对象 23 * @return true 表示执行成功 ;false 失败 24 */ 25 public boolean deleteAuthorization(Authorization authorization); 26 27 /** 28 * updateAuthorization 更新授权 29 * @param authorization 授权对象 30 * @return true 表示执行成功 ;false 失败 31 */ 32 public boolean updateAuthorization(Authorization authorization); 33 34 /** 35 * getAuthorization 获取授权 36 * @param authorization 授权对象 37 */ 38 public void getAuthorization(Authorization authorization); 39 40 }
生成的部分文档截图：
=========================风骚的分割线=========================
说明一下注释：
1、单行注释
2、块注释
3、尾端注释
4、行末注释
5、文档注释(生成开发帮助文档)
[1]、利用eclipse和javadoc工具生成开发API文档【自定义一个文件夹存放，否则生成一大堆文件；注意采用UTF-8编码 否则乱码】
类 接口 方法 字段声明前
[2]、默认只为public 和 protect 生成注释；private 和默认 需要在生成时候配置
[3]、注释命令
@author 作者信息
@version 版本信息
@param 参数信息
@return 返回值
@since 最早见于某个版本
@exception 异常信息 可以存在多个
@deprecated 不建议使用 将来可能会摒弃的方法
1 /**
2 *汽车类的简介
3 *<p>汽车类具体阐述第一行<br>
4 *汽车类具体阐述第二行
5 *@author man
6 *@author man2
7 *@version 1.0
8 *@see ship
9 *@see aircraft
10 */
11 public class BusTestJavaDoc{
12 /**
13 *用来标识汽车行驶当中最大速度
14 *@see #averageSpeed
15 */
16 public int maxSpeed;
17 /**用来标识汽车行驶当中平均速度*/
18 public int averageSpeed;
19 /**用来标识汽车行驶当中的水温*/
20 public int waterTemperature;
21 /**用来标识天气温度*/
22 public int Temperature;
23 BusTestJavaDoc(){
24
25 }
26 /**
27 *该方法用来测量一段时间内的平均速度
28 *@param start 起始时间
29 *@param end 截止时间
30 *@return 返回int型变量
31 *@exception java.lang.exceptionthrowwhenswitchis1
32 */
33 public int measureAverageSpeed(int start,int end ){
34 int aspeed=12;
35 return aspeed;
36 }
37 /**
38 * 该方法用来测量最大速度
39 */
40 public int measureMaxSpeed(){
41 return maxSpeed;
42 }
43 }
写好这些注释后，eclipse ->文件->export->java->javadoc->
下一步->
Next->选择Finish 完成；
