Une brève discussion sur le rôle de l'annotation @param et de l'annotation @see en Java

@ param
La balise @ param peut archiver un seul paramètre d'une méthode ou d'un constructeur, ou taper les paramètres d'une classe, d'une interface ou d'une méthode générique. Lors de l'utilisation de la balise @param, nous devons en utiliser une pour chaque paramètre de la méthode. Le premier mot de chaque paragraphe sera traité comme le nom du paramètre, et les parties restantes seront traitées comme sa description :

@param max The maximum number of words to read.

Lors de l'archivage des paramètres de type, nous devons ajouter < et > des deux côtés du nom du paramètre de type :

@param一e element type of this List

Cependant, les paramètres de type ne nécessitent généralement pas de documentation explicite, car ils sont très évidents. La balise

@ see
@ see peut créer des références croisées qui renvoient vers d'autres documents javadoc. Nous pouvons nommer n'importe quel identifiant d'après cette balise, même si nous devons le qualifier pleinement. Par exemple, vous pouvez généralement nommer un membre de classe par son nom simple, mais si le membre est une méthode surchargée, vous devez spécifier la version surchargée de la méthode en énumérant les types de chaque paramètre. Nous pouvons utiliser des noms non qualifiés pour spécifier des interfaces ou des classes dans le package actuel, mais nous devons utiliser des noms complets pour spécifier des types dans d'autres packages. Nous pouvons spécifier les membres d'un type en utilisant # devant le nom du membre. Les formats de balises @ see suivants sont tous valides :

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

La première forme fait référence à la méthode nommée getName, qui est la même que le commentaire de la documentation lui-même. dans la même classe ou interface, ou dans une classe ou interface environnante, cette syntaxe peut également être appliquée aux constructeurs et aux champs. La deuxième forme fait référence à une classe dans le package actuel ou à une classe dans un package importé. La troisième forme fait référence à une classe en utilisant son nom complet.

Les quatre dernières formes de @see font référence aux membres, parmi lesquelles les deux premières concernent le domaine (DECK-SIZ) et la méthode (getName). Nous pouvons utiliser directement le nom de la méthode, car dans l'Attr. class Une seule méthode getName est définie dans. Les deux dernières formes font référence au constructeur de la classe Attr. Un constructeur accepte un argument de chaîne, tandis que l'autre constructeur accepte une chaîne et un objet. Ou lorsqu'une méthode a une version surchargée, nous. doit préciser l'argument de la version surchargée que l'on souhaite référencer. Le formulaire @see suivant dirige le lecteur vers un package spécifique : com.magic.attro

Les deux derniers formulaires permettent de référencer d'autres documents. Le premier utilise pour définir des liens, et le second utilise des guillemets pour placer le nom du document. Nous pouvons utiliser ces deux formes pour diriger les lecteurs vers celui-ci, comme des instructions complètes. une entité de langage (tous les formulaires sauf les deux derniers formulaires ci-dessus) peut être suivie d'un label Dans le document généré, le nom de ce label remplacera le nom de l'entité. Par exemple :

.

@ see #getNameAttribute Names

créera un lien vers le document de getName Mais le texte qu'il affiche est "Noms d'attribut" au lieu de "getName". les fonctionnalités présentées ici peuvent parfois être utiles.

Plus de conseils en Java Pour les articles liés au rôle de l'annotation @param et de l'annotation @see, veuillez faire attention au site Web PHP chinois

.