在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 coc_k
* @version 1.0
*/
public class aTest
{
/**
* 簡單測試成員變量
*/
protected String name;
/**
* 主方法，程序的入口
*/
public static void main(String[] args)
{
System.out.println("Hello World!");
}
}在寫一個測試類：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 class bTest
{
/**
* 簡單測試成員變量
*/
public int age;
/**
* Test類的測試構造器
*/
public bTest()
{
}
}在寫一個測試類：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講義第三版