如何寫Java註釋,如何寫Java文件註釋

2021-03-04 05:20:05 字數 2164 閱讀 9162

1樓:青鳥中關村專家

/*** @author

* @param name

* @copy

*/表示的是文件註釋,文件註釋裡可以以作者名,引數的意義,版本等等。對於方法的文件註釋,可以在方法的上面輸入「/**」按回車,就會出來了

2樓:匿名使用者

文件註釋與一般註釋的最大區別在於起始符號是/**而不是/*或///*** 這是文件註釋

*/乙個文件註釋由兩部分組成:

/*** 描述部分(description)** 標記部分(block tags)*/

3樓:匿名使用者

單純的註釋有兩種:

/*** 註釋註釋

* 註釋註釋*/和

//註釋註釋

java 文件註釋是註釋什麼的,不是有多行註釋了嗎?

4樓:香料魔法

1、【文件註釋】是寫在類或者方法的上面的。

文件註釋可以用eclipse匯出chm格式的幫助文件,拿給其他人用時,方便他人理解。文件註釋被呼叫的方法,當滑鼠移到上面時提醒註釋內容。

使用文件註釋時,需要在開始的 /** 之後,第一行或幾行是關於類、變數和方法的主要描述。

之後,可以包含乙個或多個何種各樣的@ 標籤。每乙個@標籤必須在乙個新行的開始或者在一行的開始緊跟星號(*)。多個相同型別的標籤應該放成一組。

2、【多行註釋】註釋的也是方法或類,言下之意就是一次性的將程式中的多行**註釋掉,但多行註釋的內容不能用於生成乙個開發者文件。

3、【多行註釋與文件註釋的區別】多行註釋的內容不能用於生成乙個開發者文件,而文件註釋 的內容可以生產乙個開發者文件。

擴充套件資料

java常用的文件註釋標籤

1、@author:標識乙個類的作者

例項: @author description

2、@deprecated:指名乙個過期的類或成員

例項: @deprecated description

3、@exception:標誌乙個類丟擲的異常

例項:@exception exception-name explanation

4、:從直接父類繼承的註釋

例項:inherits a ***ment from the immediate surperclass.

5、:插入乙個到另乙個主題的鏈結

例項:6、:插入乙個到另乙個主題的鏈結,但是該鏈結顯示純文字字型

例項:inserts an in-line link to another topic.

7、@param:說明乙個方法的引數

例項:@param parameter-name explanation

8、@return:說明返回值型別

例項:@return explanation

9、@see:指定乙個到另乙個主題的鏈結

例項:@see anchor

10、@serial:說明乙個序列化屬性

例項:@serial description

5樓:匿名使用者

java 的註釋大致分為3塊

1、行註釋

就是在一行的最前端 寫上 「//」

2、塊註釋

就是在要註釋的**塊的前面加上 「/*」在結尾加上「*/」

3、文件註釋

文件註釋一般用於方法或類上

如:/**

* 數獨實體類

* @author administrator**/public class shudu{}

這樣寫的好處是,你在其它類裡new出該類的時候,按alt + 「/" 可以看到自己寫的「數獨實體類」

更重要的是,寫文件註釋可以用eclipse匯出chm格式的幫助文件,拿給其他人用,別人也方便理解嘛。。哈哈

6樓:匿名使用者

文件註釋完了之後可以用工具生成乙個文件的

7樓:匿名使用者

java類中有/** */ 一般用來說明乙個類或者乙個方法的作用和/* */ 用來遮蔽一大段無效的**,和// 用來說明這一行**的作用,

jsp中的註釋

一般用來遮蔽不需要輸出的內容或者用來註釋整個**的簡單說明,一般來說,註釋都是讓別人更容易讀懂自己**的

如何寫如何寫古詩,如何寫詩詞?

天天背上500首,不間斷2個月,之後你就會成天說5個或7個字,停頓再想想 如何寫詩詞?一是思維是全過程始終不離開形象。創作中的思維過程是 物象 直感印象 審美意象 藝術形象 這樣乙個形象思維過程。用畫竹來概括就是 園中之竹 眼中之竹 胸中之竹 筆下之竹 的過程。在這個過程中,畫家的思維始終沒有離開 ...

家長如何寫反思 ,家長如何寫反思 50字

寫自己如何如何沒有教育好孩子。之類的。對本次月考失利做總結 然後寫以後會如何教育孩子 還有可以寫 對教育孩子的看法。最後可以寫 下次月考目標 家長寫的反思怎麼寫 50字以上的 家長反思50字怎麼寫 家長檢討書一 接到孩子本學期遲到三次的通知,讓我很吃驚。遲到三次,共遲到6分鐘 簡單的一句話,說明了很...

讀後感如何寫,如何寫讀後感?

怎樣寫讀後感 讀後感的意思就說讀了一本書,一篇文章,一段話,或幾句名言後,把具體的感受和得到的啟示寫成的文章,這就稱之為讀後感 讀後感的格式 第一段把書裡面的一些主要的內容,加以概括,作者寫了些什麼,想表達些什麼。第二段選擇乙個其中比較重要的點,也可以是自己認為重要的一些地方,把它表達出來,切記是要...