如何生成一個java檔案

眾所周知，一個程式給別人看可能可以看懂，幾萬行程式就不一定了，在更多的時候，我們并不需要讓別人知道我們的程式是怎么寫的，只需要告訴他們怎么用的，那么，api檔案就發揮了它的作用，

1. 什么是api檔案？

顧名思義，檔案是給人看的，那么api檔案就是告訴別人我的程式要怎么用，一個最典型的例子就是JDK8的幫助檔案，如圖：JDK8檔案鏈接)

一看：一目了然，想找什么都有，極大地方便了我們這種使用JDK的人，

既然要生成檔案，我們就需要一個寫好檔案注釋，在類和方法前使用/** xxx */來進行檔案注釋

標簽	描述	實體
@author	標識一個類的作者	@author description
@deprecated	指名一個過期的類或成員	@deprecated description
{@docRoot}	指明當前檔案根目錄的路徑	Directory Path
@exception	標志一個類拋出的例外	@exception exception-name explanation
{@inheritDoc}	從直接父類繼承的注釋	Inherits a comment from the immediate surperclass.
{@link}	插入一個到另一個主題的鏈接	{@link name text}
{@linkplain}	插入一個到另一個主題的鏈接，但是該鏈接顯示純文本字體	Inserts an in-line link to another topic.
@param	說明一個方法的引數	@param parameter-name explanation
@return	說明回傳值型別	@return explanation
@see	指定一個到另一個主題的鏈接	@see anchor
@serial	說明一個序列化屬性	@serial description
@serialData	說明通過writeObject( ) 和 writeExternal( )方法寫的資料	@serialData description
@serialField	說明一個ObjectStreamField組件	@serialField name type description
@since	標記當引入一個特定的變化時	@since release
@throws	和 @exception標簽一樣.	The @throws tag has the same meaning as the @exception tag.
{@value}	顯示常量的值，該常量必須是static屬性，	Displays the value of a constant, which must be a static field.
@version	指定類的版本	@version info

例如：

/** 這個類繪制一個條形圖
* @author runoob
* @version 1.2
*/

以及我自己的：

這樣，就寫好了檔案注釋，

打開cmd，來到專案目錄，一個命令javadoc極大地方便了我們

javadoc -encoding UTF-8 -charset UTF-8 Doc.java

注意：一定要輸入-encoding UTF-8 -charset UTF-8 這個東西，否則你寫的中文注釋全是亂碼，

然后，你就會看到當前目錄下多出來了一堆檔案：

重點是index.html，如果你們有學習或了解過網站組成的話，就會知道index.html是網站目錄下的索引，打開它相當于打開了一個頁面，

打開它，一個熟悉的視窗：

不知道你們有沒有開始用IDEA來寫java程式，反正我最近是轉IDEA了，確實舒服，那我還是扯兩句如何生成doc：

最后感謝嗶哩嗶哩up朱遇見狂神說的視頻

遇見狂神說的個人空間_嗶哩嗶哩_bilibili

轉載請註明出處，本文鏈接：https://www.uj5u.com/houduan/467953.html

標籤：其他