榮新教育:堅持面授的良心機構
全國咨詢熱線:400-1335-066
您現在的位置:首頁>行業新聞 > 正文

Java文檔注釋

時間:2018-07-12 17:54:23 來源:榮新IT教育培訓 作者:榮新科技
今天事情比較多,就不多說啥了,榮新教育今天給大家分享的是一些java的基礎知識,文檔注釋的知識,一起來看看吧。
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
文章源自榮新教育官網:www.gdkongjian.com歡迎訪問,轉載需注明出處

夜射猫精品在线av