@param
La balise @param peut archiver un paramètre unique d'une méthode ou d'un constructeur, ou de type paramètres d'une classe d'archives, d'une interface et de méthodes génériques. Lorsque vous utilisez la balise @param, nous devons utiliser l'une des balises pour chaque paramètre de la méthode. Le premier mot de chaque paragraphe sera considéré comme un nom de paramètre, tandis que le reste sera considéré comme une description de celui-ci:
@param max le nombre maximum de mots à lire.
Lors de l'archivage des paramètres de type, nous devons ajouter <et> aux deux côtés du nom du paramètre de type:
@param 体中国中国中国中国
Cependant, les paramètres de type ne nécessitent généralement pas de documentation explicite, car ils sont tous très évidents.
@ voir
Les balises @see peuvent créer des références croisées liées à d'autres documents Javadoc. Nous pouvons nommer des identifiants après la balise, bien que nous devons les qualifier pleinement. Par exemple, il peut généralement être nommé avec un nom simple d'un membre d'une classe, mais si le membre est une méthode surchargée, nous devons spécifier la version surchargée de la méthode en énumérant les types de chaque paramètre. Nous pouvons utiliser un nom non qualifié pour spécifier l'interface ou la classe dans le package actuel, mais nous devons utiliser un nom entièrement qualifié pour spécifier les types dans d'autres packages. Nous pouvons spécifier des membres du type en utilisant # avant le nom du membre. Voici tous les formats de balises valides @ Voir:
@see #getname @see att @see com.magic.attr.attr @see com.magic.attr.deck # deck-size @see com.magic.attr.attr # getName @see com.magic.attr.attr # att (string) @see com.magic.attr.attr # attrib (String) @see com.Magc.attr. Objet) @see com.magic.attr @see d'attribut spécification @see "L'almanac du développeur Java"
Le premier formulaire fait référence à une méthode appelée GetName, qui est située dans la même classe ou l'interface que l'annotation du document elle-même, ou dans une certaine classe environnante ou interface environnante. Une telle syntaxe peut également être appliquée aux constructeurs et aux champs. Le deuxième formulaire fait référence à la classe dans le package actuel ou la classe dans un certain package de guide. Le troisième formulaire fait référence à une classe utilisant un nom entièrement qualifié.
Les 4 dernières formes de @SeE se réfèrent aux membres, où les deux premiers concernent les domaines (Deck-Siz Day and Method (getName). Nous pouvons utiliser le nom de la méthode directement car une seule méthode GetName est définie dans la classe ATRT. Nous voulons nous référer.
Le formulaire @SEE suivant mène le lecteur à un package spécifique: com.magic.attro
Les deux dernières formulaires nous permettent de citer d'autres documents. Parmi eux, le précédent utilise pour définir le lien, et le second utilise des citations pour enfermer le nom du document. Nous pouvons utiliser les deux formulaires pour diriger le lecteur vers d'autres documents, tels que le manuel complet.
Le formulaire @SeE (toutes les formulaires sauf les deux dernières formes ci-dessus) qui nomment l'entité linguistique peuvent être suivies d'une étiquette. Dans le document généré, ce nom d'étiquette remplacera le nom de l'entité. Par exemple:
@ Voir les noms #GetNameAttribute
Un lien vers le document de GetName sera créé, mais le texte qu'il affiche est "Noms d'attribut" au lieu de "getName". Habituellement, nous devons utiliser les vrais noms des membres, mais les fonctionnalités présentées ici sont parfois utiles.