給自己的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文件夾!
給自己的java程序生成API幫助文檔