Tutoriel Java avancé : que produit javadoc ?

L'outil javadoc prend le code source de votre programme Java en entrée et génère des fichiers HTML contenant des commentaires sur votre programme.

Les informations pour chaque classe seront dans un fichier HTML séparé. Javadoc peut également générer des arborescences et des index hérités.

Étant donné que l'implémentation de javadoc est différente, le travail peut également être différent. Vous devez vérifier la version de votre système de développement Java et d'autres détails pour choisir la version Javadoc appropriée.

Exemple

Ce qui suit est un exemple simple d'utilisation des commentaires de description. Notez que chaque commentaire précède l'élément qu'il décrit.

Après avoir été traités par javadoc, les commentaires de la classe SquareNum se retrouveront dans SquareNum.html.

import java.io.*;
  
/**
* This class demonstrates documentation comments.
* @author Ayan Amhed
* @version 1.2
*/
public class SquareNum {
   /**
   * This method returns the square of num.
   * This is a multiline description. You can use
   * as many lines as you like.
   * @param num The value to be squared.
   * @return num squared.
   */
   public double square(double num) {
      return num * num;
   }
   /**
   * This method inputs a number from the user.
   * @return The value input as a 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);
   }
}
如下，使用javadoc工具处理SquareNum.java文件：
 
$ 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
$

Ce qui précède est le didacticiel Java avancé : ce que le javadoc produit. Pour plus de contenu connexe, veuillez faire attention au site Web PHP chinois (www.php.cn) !