Eine kurze Diskussion über die Rolle der @param-Annotation und der @see-Annotation in Java

@ param
Das @ param-Tag kann einen einzelnen Parameter einer Methode oder eines Konstruktors oder Typparameter einer Klasse, Schnittstelle oder generischen Methode archivieren. Wenn wir das @param-Tag verwenden, sollten wir eines für jeden Parameter der Methode verwenden. Das erste Wort jedes Absatzes wird als Parametername behandelt und die übrigen Teile werden als Beschreibung behandelt:

@param max The maximum number of words to read.

Beim Archivieren von Typparametern sollten wir < hinzufügen. und > auf beiden Seiten des Typparameternamens:

@param一e element type of this List

Typparameter benötigen jedoch normalerweise keine explizite Dokumentation, da ihre Bedeutung sehr klar ist. Mit dem Tag

@ see
@ see können Querverweise erstellt werden, die auf andere Javadoc-Dokumente verweisen. Wir können jeden Bezeichner nach diesem Tag benennen, müssen ihn jedoch vollständig qualifizieren. Beispielsweise können Sie ein Klassenmitglied normalerweise nach seinem einfachen Namen benennen. Wenn es sich bei dem Mitglied jedoch um eine überladene Methode handelt, müssen Sie die überladene Version der Methode angeben, indem Sie die Typen der einzelnen Parameter auflisten. Wir können unqualifizierte Namen verwenden, um Schnittstellen oder Klassen im aktuellen Paket anzugeben, aber wir müssen vollständig qualifizierte Namen verwenden, um Typen in anderen Paketen anzugeben. Wir können Mitglieder eines Typs angeben, indem wir # vor dem Mitgliedsnamen verwenden. Die folgenden sind alle gültigen @ see-Tag-Formate:

@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"

Das erste Formular bezieht sich auf die Methode mit dem Namen getName, die mit dem Dokumentationskommentar selbst identisch ist In derselben Klasse oder Schnittstelle oder in einer umgebenden Klasse oder Schnittstelle kann diese Syntax auch auf Konstruktoren und Felder angewendet werden. Die zweite Form bezieht sich auf eine Klasse im aktuellen Paket oder eine Klasse in einem importierten Paket. Die dritte Form bezieht sich auf eine Klasse unter Verwendung ihres vollständig qualifizierten Namens.

Die letzten vier Formen von @see beziehen sich auf Mitglieder, wobei es bei den ersten beiden um die Domäne (DECK-SIZ) und die Methode (getName) geht. Wir können den Methodennamen direkt verwenden, da im Attr In der Klasse ist nur eine getName-Methode definiert. Die beiden letztgenannten Formen beziehen sich auf den Konstruktor der Attr-Klasse, während der andere Konstruktor eine Zeichenfolge und ein Objekt akzeptiert. Oder wenn eine Methode eine überladene Version hat muss das Argument der überladenen Version angeben, auf die wir verweisen möchten. Das folgende @see-Formular leitet den Leser zu einem bestimmten Paket weiter: 🎜>

@ see #getNameAttribute Names