La fonction de l'outil jdk javadoc est de "générer de la documentation Java" ; javadoc est un générateur de documentation Java qui extrait des commentaires tels que des classes, des méthodes, des membres, etc. du code source du programme pour former une aide API. document qui correspond au code source.
Recommandations associées : "Tutoriel vidéo Java"
La fonction de l'outil jdk javadoc est de "générer un document Java".
Javadoc est une technologie fournie par Sun. Elle extrait des commentaires tels que les classes, les méthodes, les membres, etc. du code source du programme pour former un document d'aide API qui correspond au code source. En d'autres termes, tant que vous utilisez un ensemble spécifique de balises comme commentaires lors de l'écriture d'un programme, une fois le programme écrit, la documentation de développement du programme peut être formée en même temps via Javadoc.
La commande javadoc permet de générer votre propre documentation API. Comment l'utiliser : Utilisez la ligne de commande pour saisir javadoc + nom du fichier.java dans le répertoire où se trouve le fichier cible.
Balises communes
Étiquette | Description | Doclet JDK 1.1 | Doclet standard | Type d'étiquette | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@auteur auteur | Identification de l'auteur | √ | √ | Package, classe, interface | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@version Numéro de version | Numéro de version | √ | √ | Package, classe, Interface | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@param Description du nom du paramètre | Le nom du paramètre d'entrée et les informations de description de la méthode. Si vous avez des exigences particulières pour les paramètres d'entrée, vous pouvez. commentez ici. | √ | √ | Constructeur, méthode | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@return description | Commentaires sur les valeurs de retour de la fonction | √ | √ | Méthodes | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@texte expiré obsolète | indique qu'à mesure que la version du programme augmente, l'API actuelle a expiré. Ceci uniquement pour garantir que la compatibilité existe toujours et pour informer les développeurs qu'ils ne doivent plus utiliser cette API. | √ | √ | Package, classe, interface, plage de valeurs, constructeur, méthode | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@ nom de classe throwsException | Exception levée par le constructeur ou la méthode. |
|
√ | Constructeur, méthode | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@nom de classe d'exception | td> | Identique à @throws. | √ | √ | Constructeur, méthode | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@voir référence | Afficher le contenu associé, tel que les classes, les méthodes, les variables, etc. | √ | √ | Package, classe, interface, plage de valeurs, constructeur, méthode | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
@ depuis le texte de description | Quelle version du programme l'API est développée pour prendre en charge. | √ | √ | Package, classe, interface, plage de valeurs, constructeur, méthode | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
{ @link package.class#member tag> | Lien vers le document correspondant à un membre spécifique. | √ | Package, classe, interface, plage de valeurs, constructeur, méthode | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Lors de l'annotation d'une constante, si vous souhaitez inclure sa valeur dans le document, référencez la valeur de la constante via cette balise. | √(JDK1.4) | Plage de valeurs statiques |
De plus, il existe plusieurs balises peu courantes telles que @serial, @serialField, @serialData, {@docRoot}, {@inheritDoc}, {@literal}, {@code} {@value arg}. utilisation, nous n'entrerons pas dans la description. Les lecteurs intéressés peuvent consulter la documentation d'aide. Pour plus de connaissances sur la programmation, veuillez visiter :
Introduction à la programmation ! !Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!