English | 简体中文 | 繁體中文 | Русский язык | Français | Español | Português | Deutsch | 日本語 | 한국어 | Italiano | بالعربية
Java supporte trois types de commentaires. Les deux premiers sont // et /* */，le troisième est appelé commentaire de détail, il se caractérise par /** Commence, avec */Fin.
Les commentaires de description permettent d'embeder des informations sur le programme dans votre code. Vous pouvez utiliser l'outil javadoc pour générer ces informations et les exporter dans un fichier HTML.
Les commentaires de description permettent de documenter votre programme de manière plus facile. Vous pouvez utiliser l'outil javadoc pour générer des informations et les exporter dans un fichier HTML.
Le outil javadoc reconnaît les étiquettes suivantes :
| Étiquette | Description | Exemple |
|---|---|---|
| @author | Identifier l'auteur d'une classe. | @author description |
| @deprecated | Indiquer une classe ou un membre obsolète. | @deprecated description |
| {@docRoot} | Indiquer le chemin d'accès au répertoire racine du document actuel. | Directory Path |
| @exception | Marquer une exception lancée par une classe. | @exception exception-name explanation |
| {@inheritDoc} | Les commentaires hérités de la classe parent immédiate. | Inherits a comment from the immediate surperclass. |
| {@link} | Insérer un lien vers un autre sujet. | {@link name text} |
| {@linkplain} | Insérer un lien vers un autre sujet, mais ce lien affiche un texte en texte pur. | Inserts an in-line link to another topic. |
| @param | Décrire un paramètre de méthode. | @param parameter-name explanation |
| @return | Décrire le type de valeur de retour. | @return explanation |
| @see | Spécifier un lien vers un autre sujet. | @see anchor |
| @serial | Décrire une propriété sérialisée. | @serial description |
| @serialData | Décrire les données écrites par les méthodes writeObject( ) et writeExternal( ). | @serialData description |
| @serialField | Décrire un composant ObjectStreamField. | @serialField name type description |
| @since | Marquer lorsque l'introduction d'un changement spécifique. | @since release |
| @throws | Comme la balise @exception. | La balise @throws a la même signification que la balise @exception. |
| {@value} | Afficher la valeur d'une constante, qui doit être une propriété statique. | Affiche la valeur d'une constante, qui doit être un champ statique. |
| @version | Spécifie la version de la classe | @version info |
Dans le /** après, la première ou les premières lignes sont principalement des descriptions de la classe, des variables et des méthodes.
peut inclure une ou plusieurs sortes variées de @ balises. Chaque @ Les balises doivent commencer sur une nouvelle ligne ou être suivies immédiatement d'une étoile sur une ligne (*).
Les balises du même type doivent être regroupées. Par exemple, si vous avez trois @see Les balises, vous pouvez les placer les unes à la suite des autres.
Voici un exemple de commentaire de description de classe :
/*** Cette classe dessine un graphique en barres. * @author w3codebox * @version 1.2 */
L'outil javadoc prend le code source de votre programme Java en entrée et génère des fichiers HTML contenant les commentaires de votre programme.
Les informations de chaque classe seront dans des fichiers HTML distincts. javadoc peut également générer une structure arborescente et un index des héritages.
En raison des différences dans l'implémentation de javadoc, le travail peut varier. Vous devez vérifier la version de votre système de développement Java et d'autres détails pour choisir la version appropriée de Javadoc.
Voici un exemple simple de commentaires de description d'utilisation. Notez que chaque commentaire est placé devant l'élément qu'il décrit.
Après traitement par javadoc, les commentaires de la classe SquareNum seront trouvés dans SquareNum.html.
import java.io.*;
/**
* Cette classe montre les commentaires de documentation
* @author Ayan Amhed
* @version 1.2
*/
public class SquareNum {
/**
* Cette méthode renvoie le carré de num.
* Voici une description multiligne. Vous pouvez utiliser
* autant de lignes que vous le souhaitez.
* @param num La valeur à carrer.
* @return Le carré de num.
*/
public double square(double num) {
return num * num;
}
/**
* Cette méthode saisit un nombre fourni par l'utilisateur.
* @return La valeur entrée en tant que double.
* @exception IOException On input error.
* @see IOException
*/
public double getNumber() throws IOException {}}
InputStreamReader isr = new InputStreamReader(System.in);
BufferedReader inData = new BufferedReader(isr);
String str;
str = inData.readLine();
return (new Double(str)).doubleValue();
}
/**
* This method demonstrates square().
* @param args Unused.
* @return Nothing.
* @exception IOException On input error.
* @see IOException
*/
public static void main(String args[]) throws IOException
{
SquareNum ob = new SquareNum();
double val;
System.out.println("Enter value to be squared: ");
val = ob.getNumber();
val = ob.square(val);
System.out.println("Squared value is " + val);
}
}As follows, use the javadoc tool to process the SquareNum.java file:
$ javadoc SquareNum.java Loading source file SquareNum.java... Constructing Javadoc information... Standard Doclet version 1.5.0_13 Building tree for all the packages and classes... Generating SquareNum.html... SquareNum.java:39: warning - @return tag cannot be used\ in method with void return type. Generating package-frame.html... Generating package-summary.html... Generating package-tree.html... Generating constant-values.html... Building index for all the packages and classes... Generating overview-tree.html... Generating index-all.html... Generating deprecated-list.html... Building index for all classes... Generating allclasses-frame.html... Generating allclasses-noframe.html... Generating index.html... Generating help-doc.html... Generating stylesheet.css... 1 warning $