java如何生成api文档_给自己的java程序生成API帮助文档

一.问题发现：

课本上提到“要学会给自己编写的程序生成API帮助文档”，但又没有说明具体的操作步骤。

二.分析：

API帮助文档有什么用？这么理解吧：如果想告诉别人你的类如何使用，里面有什么方法，要什么参数的话，除了现场解释，最好的方法是什么呢？

对了，就是写一份说明！一般开头可以有这么几项：

/**

* 项目说明

* @author 作者

* @version 版本

* @param 参数

* @return 返回值含义

* @throws 抛出异常的描述

* @deprecated 废弃，即不建议使用

*/

网上说用eclipse可以很方便地形成API帮助文档。于是拿了个以前编写的程序：

/**

* 循环测试

* @author java学习者

* @version 版本1.0

* @param 无

* @return 无

* @throws 无

* @deprecated 无

*/

package j2_14_38;

public class DoWhile

{

public static void main(String[] args)

{

int i=1;

do

{

System.out.println(“这是第 “+i+“次循环”);

//i=6即跳出循环

i++;

}while(i<6);

}1

}

然后按以下步骤操作：

右击项目->导出(Export)->Java->javadoc->Next->Next->Next->Finish->Yes To All->Finish。

最后发现，在项目中，多了个doc文件夹！