文件註釋使用javadoc工具生成自己的api幫助文件
阿新 • • 發佈：2019-02-14
在java開發中定義類、方法時可以新增文件註釋，用 javadoc 工具來生成自己的 API 文件。
文件註釋以斜線後緊跟兩個星號（/**）開始，以星號後緊跟一個斜線（*/）結束
下面是測試類： aTest類。包名是cock
package cock;
/**
* Description:
* <br/>我的部落格: <a href="http://blog.csdn.net/coc_k">coc_k的部落格</a>
* <br/>類的說明:此類為測試 文件註釋 所用
* <br/>Date:2016/8/27
* @author 在寫一個測試類：bTest類。包名是cock2
package cock2;
/**
* Description:
* <br/>我的部落格: <a href="http://blog.csdn.net/coc_k">coc_k的部落格</a>
* <br/>類的說明:此類為測試 文件註釋 所用
* <br/>Date:2016/8/27
* @author coc_k
* @version 1.0
*/
public 在寫一個測試類：cTest類。包名也是cock2
package cock2;
/**
* Description:
* <br/>我的部落格: <a href="http://blog.csdn.net/coc_k">coc_k的部落格</a>
* <br/>類的說明:此類為測試 文件註釋 所用
* <br/>Date:2016/8/27
* @author coc_k
* @version 1.0
*/
public class cTest
{
/**
* 一個得到打招呼字串的方法。
* @param name 該引數指定向誰打招呼。
* @return 返回打招呼的字串。
*/
public String hello(String name)
{
return name + "，你好！";
}
}以上測試類的特點是:
aTest類 的包名是cock
bTest類 和 cTest類 的包名是cock2
新建兩個資料夾: cock和cock2
將檔案aTest.java放入資料夾cock中
將檔案bTest.java和cTest.java放入資料夾cock2中
為了生成包的註釋，我們還需在cock資料夾中加一個包描述符檔案 package.html
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD>
<TITLE></TITLE>
</HEAD>
<BODY>
在這裡寫上對包cock的註釋
</BODY>
</HTML>在兩個資料夾處所在目錄下開啟控制檯，輸入指令
javadoc -d apidoc -windowtitle 測試 -doctitle 學習javadoc的測試API文件 -header 我的類 -version -author cock cock2此時就生成了自己的api幫助文件
在資料夾cock所在目錄生成資料夾apidoc,開啟此資料夾下的index.html檔案，檢視生成的api文件
自己寫的原始碼可以生成api文件，太酷了！
內容來自：瘋狂java講義第三版