@param
Das @Param -Tag kann einen einzelnen Parameter einer Methode oder einen Konstruktor archivieren oder Parameter einer Archivklasse, Schnittstelle und generischen Methoden typisieren. Bei Verwendung des @Param -Tags sollten wir eines der Tags für jeden Parameter der Methode verwenden. Das erste Wort in jedem Absatz wird als Parametername angesehen, während der Rest als Beschreibung davon angesehen wird:
@param max die maximale Anzahl von Wörtern zu lesen.
Beim Archivierungsparameter Archivierungsparameter sollten wir zu beiden Seiten des Typ -Parameternamens <und> hinzufügen:
@param 体中国中国中国中国
Typparameter erfordern jedoch normalerweise keine explizite Dokumentation, da sie alle sehr offensichtlich sind.
@ sehen
@see Tags können Kreuzreferenzen erstellen, die mit anderen Javadoc -Dokumenten verknüpft sind. Wir können alle Kennungen nach dem Tag benennen, obwohl wir sie vollständig qualifizieren müssen. Beispielsweise kann es normalerweise mit einem einfachen Namen eines Mitglieds einer Klasse benannt werden. Wenn das Mitglied jedoch eine überladene Methode ist, müssen wir die überlastete Version der Methode angeben, indem wir die Typen jedes Parameters aufzählen. Wir können einen nicht qualifizierten Namen verwenden, um die Schnittstelle oder Klasse innerhalb des aktuellen Pakets anzugeben. Wir müssen jedoch einen voll qualifizierten Namen verwenden, um die Typen in anderen Paketen anzugeben. Wir können Mitglieder des Typs angeben, indem wir # vor dem Mitgliedsnamen verwenden. Hier sind alle gültig @ siehe Tag -Formate:
@see #getname @see attr @see com.magic.attr.attr @see com.magic.attr.deck#Deck-Größe @see com.magic.attr.attr #name @see com.magic.attr.attr#attr (STING) @see Com.attr.attr.attr.attr.attr.attr.attr.attr.attr.attr.attr.attr.attr.attr.attr (String) @seeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee. com.magic.attr.attr#attr (String, Objekt) @see com.magic.attr @see Attributspezifikation @see "Der Almanac des Java -Entwicklers"
Die erste Form bezieht sich auf eine Methode namens GetName, die sich in derselben Klasse oder Schnittstelle wie das Dokumentanschlag selbst oder in einer bestimmten Umgebung oder Umgebung befindet. Eine solche Syntax kann auch auf Konstruktoren und Felder angewendet werden. Die zweite Form bezieht sich auf die Klasse im aktuellen Paket oder in der Klasse in einem bestimmten Leitfadenpaket. Die dritte Form bezieht sich auf eine Klasse mit einem voll qualifizierten Namen.
Die letzten 4 Formen von @see beziehen sich auf Mitglieder, bei denen sich die ersten beiden um Domänen (Deck-Siz-Tag und Methode (getName) befassen. Wir können den Methodennamen direkt verwenden, da nur eine GETNAME-Methode in der ATTR-Klasse definiert ist. Die letzten beiden Formulare beziehen sich auf die Konstruktorin der ATTR-Klasse, von denen eine Saiten-Zitate akzeptiert, und die anderen, die überlegt werden. Wenn Sie die Überlagerung und die Überlagerung annehmen. Zitate, auf die wir uns beziehen möchten.
Das nächste @See -Formular führt den Leser zu einem bestimmten Paket: com.magic.attro
Die letzten beiden Formen ermöglichen es uns, andere Dokumente zu zitieren. Unter ihnen definiert der vorherige den Link, und letzteres verwendet Zitate, um den Dokumentnamen einzuschließen. Wir können beide Formulare verwenden, um den Leser auf andere Dokumente zu lenken, z. B. das vollständige Handbuch.
Das @See -Formular (alle Formulare mit Ausnahme der letzten beiden oben genannten Formulare), die die Sprachentität nennen, kann von einem Etikett folgen. Im generierten Dokument ersetzt dieser Label -Name den Namen der Entität. Zum Beispiel:
@ siehe #getNameattribute Namen
Ein Link zum Dokument von GetName wird erstellt, aber der von ihm angezeigte Text lautet "Attributnamen" anstelle von "getName". Normalerweise sollten wir die echten Namen der Mitglieder verwenden, aber die hier gezeigten Funktionen sind gelegentlich nützlich.