Java Documentation Commentaires
Java Annotations seulement trois sortes de façons. Les deux premiers sont // et / * * /, et le troisième est appelé le commentaire de la légende qui commence par / **, fin avec * /.
Description Commentaire vous permet d'intégrer des informations sur le programme dans le programme. Vous pouvez utiliser l'outil javadoc pour générer des informations et la sortie vers des fichiers HTML.
Description Commentaire, vous enregistrer plus d'informations au sujet de votre programme.
javadoc tag
javadoc reconnaît les balises suivantes:
| étiquette | description | exemple |
|---|---|---|
| @author | Identifie une classe d'auteurs | Description @author |
| @deprecated | Nommé membre de la classe ou expiré | Description @deprecated |
| {@docRoot} | Chemin d'accès spécifié dans le répertoire courant racine du document | Chemin du répertoire |
| @exception | Marquer une exception de classe jetés | @exception exception nom explication |
| {@inheritDoc} | Directement à partir du parent classe hérite commentaire | Hérite un commentaire de la surperclass immédiate. |
| {@link} | Insertion d'un lien à un autre sujet | {@link Texte Nom} |
| {@linkplain} | Insérer un lien vers un autre sujet, mais le lien est affiché dans la plaine police du texte | Insère un lien en ligne à un autre sujet. |
| @param | Description d'un paramètre de procédé | @param nom paramètre explication |
| @return | Type de retour Description | explication @return |
| @see | Indique un lien vers un autre sujet | ancre @see |
| @serial | Une description de la séquence de la propriété | Description @serial |
| @serialData | Description Méthode écrit par writeObject () et writeExternal () données | Description @serialData |
| @serialField | Une description des composants ObjectStreamField | @serialField description du type de nom |
| @since | Lors de l'introduction d'un marqueur spécifique du changement | @since libération |
| @throws | Et @exception même étiquette. | La balise @throws a la même signification que la balise @exception. |
| {@value} | Valeur d'affichage d'une constante, la constante doit être une propriété statique. | Affiche la valeur d'une constante, qui doit être un champ statique. |
| @version | Version de la classe spécifiée | @version infos |
Documentation Commentaires
Après le démarrage / **, la première ligne ou des lignes est la description principale de classes, variables et méthodes.
Après cela, vous pouvez inclure un ou plusieurs de ce genre de @ tag. @ Chaque étiquette doit être sur une nouvelle ligne, ou démarrer au début d'une ligne suivie par un astérisque (*).
Une pluralité d'un même type d'étiquette doit être placé dans un groupe. Par exemple, si vous avez trois balises @see, ils peuvent être mis en place un par un.
Ce qui suit est une description d'un exemple d'un commentaire de classe:
/*** This class draws a bar chart. * @author Zara Ali * @version 1.2 */
Quelle sortie javadoc
javadoc le code source de votre programme Java comme entrée, la sortie de certains fichier HTML contenant vos annotations de programme.
Chaque type d'information sera seul dans le fichier HTML. sortie javadoc peut aussi être hérité arbre et index.
En raison de différents travaux de mise en œuvre de javadoc peut être différent, vous devez vérifier la version de votre système de développement Java et d'autres détails, sélectionnez la version appropriée de Javadoc.
Exemples
Ce qui suit est un commentaire qui explique l'utilisation d'un exemple simple. Notez que le projet précédent chaque annotation dans sa description.
Après le traitement de javadoc, des notes de classe SquareNum seront trouvées dans le 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);
}
}
Comme suit, en utilisant l'outil javadoc pour traiter le fichier 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
$