Quelle est la fonction de l'outil jdk javadoc ?-JavaBase-php.cn

Quelle est la fonction de l'outil jdk javadoc ?

青灯夜游

Libérer： 2020-10-29 09:08:01

original

5679 Les gens l'ont consulté

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.

Quelle est la fonction de l'outil jdk javadoc ?

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

{@value>

É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.

标签	说明	JDK 1.1 doclet	标准doclet	标签类型
@author 作者	作者标识	√	√	包、类、接口
@version 版本号	版本号	√	√	包、类、接口
@param 参数名描述	方法的入参名及描述信息，如入参有特别要求，可在此注释。	√	√	构造函数、方法
@return 描述	对函数返回值的注释	√	√	方法
@deprecated 过期文本	标识随着程序版本的提升，当前API已经过期，仅为了保证兼容性依然存在，以此告之开发者不应再用这个API。	√	√	包、类、接口、值域、构造函数、方法
@throws异常类名	构造函数或方法所会抛出的异常。		√	构造函数、方法
@exception 异常类名	同@throws。	√	√	构造函数、方法
@see 引用	查看相关内容，如类、方法、变量等。	√	√	包、类、接口、值域、构造函数、方法
@since 描述文本	API在什么程序的什么版本后开发支持。	√	√	包、类、接口、值域、构造函数、方法
{@link包.类#成员标签}	链接到某个特定的成员对应的文档中。		√	包、类、接口、值域、构造函数、方法
{@value}	当对常量进行注释时，如果想将其值包含在文档中，则通过该标签来引用常量的值。		√(JDK1.4)	静态值域

√

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!