小議Java中@param注解與@see注解的感化

小議Java中@param注解與@see注解的感化。本站提示廣大學習愛好者：（小議Java中@param注解與@see注解的感化）文章只能為提供參考，不一定能成為您想要的結果。以下是小議Java中@param注解與@see注解的感化正文

@ param
@ param標簽可以歸檔辦法或結構器的某個單一參數，或許歸檔類、接口和泛型辦法的類型參數。在應用@ param標簽時，我們應當針對辦法的每個參數都應用一個該標簽。每一個段落的第一個詞會被看成參數名，而余下的部門則會被看成是對它的描寫:

　　@param max The maximum number of words to read.

　　當歸檔類型參數時，我們應當在類型參數名雙方加上<和>:

　　@param一e element type of this List

　　但是，類型參數平日其實不須要顯式的文檔，由於它們的意義都很顯著。

@ see
@ see標簽可以創立鏈接到其他javadoc文檔的穿插援用。我們可以在該標簽的前面定名任何標識符，雖然我們必需對它們停止充足的限制。例如，平日可使用某個類的成員的簡略名來定名它，然則假如該成員是一個重載辦法，我們就必需經由過程羅列各個參數的類型來指定該辦法的重載版本。我們可使用未限制的名字來指定以後包內的接口或類，但必需應用完整限制名來指定其他包中的類型。我們可以經由過程在成員名的後面應用#來指定類型的成員。上面是一切有用的@ see標簽格局:

　　@see #getName

　　@see Attr

　　@see com.magic.attr.Attr

　　@see com.magic.attr.Deck#DECK-SIZE

　　@see com.magic.attr.Attr#getName

　　@see com.magic.attr.Attr#Attr(String)

　　@see com.magic.attr.Attr#Attr(String，Object)

　　@see com.magic.attr

　　@see Attribute Specification

　　@see "The Java Developer's Almanac"

　　第一種情勢所指的是名為getName的辦法，該辦法與文檔正文本身位於統一個類或接口中，或許位於某個包抄類或包抄接口中，如許的語法也能夠運用於結構器和字段。第二種情勢援用的是以後包中的類或某個導人包中的類。第三種情勢應用完整限制名援用了某個類。

　　後4種情勢的@see援用的是成員，個中，前兩個是關於域(DECK-SIZ日和辦法(getName)的情勢。我們可以直接應用辦法名，由於在Attr類中只界說了一個getName辦法。後兩種情勢援用的是Attr類的結構器，個中一個結構器接收的是字符串引元，而另外一個結構器接收的則是字符串和對象。當結構器或辦法有重載版本時，我們必需指定想要援用的重載版本的引元。

　　接上去的@see情勢將讀者引向了一個特定的包:com.magic.attro

　　最初的兩種情勢使得我們可以援用其他的文檔。個中，前一個應用了來界說鏈接，後一個應用引號將文檔名括了起來。我們可以用這兩種情勢將讀者引向其他文檔，例如完全的解釋書。

　　對說話實體停止定名的@ see情勢(除下面的最初兩種情勢以外的一切情勢)可以在實體的前面追隨一個標號(label)。在生成的文檔中，這類標號的名字將會替換實體的名字。例如:

　　@ see #getNameAttribute Names

　　將創立一個指向getName的文檔的鏈接，但它所顯示的文本是”Attribute Names”而不是"getName"。平日我們應當應用成員的真實名字，但這裡所展現的特征偶然也會很有效。