Java 文檔註釋

Java 文檔註釋

Java 支持三種註釋方式。前兩種分別是 // 和 */ */，第三種被稱做說明註釋，它以 / 開始，以 */ 結束。

說明註釋容許你在程序中嵌入關於程序的信息。你能夠使用 javadoc 工具軟件來生成信息，並輸出到HTML文件中。

說明註釋，使你更加方便的記錄你的程序信息。

---

javadoc 標籤

javadoc 工具軟件識別如下標籤：

標籤	描述	示例
@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