doc_comment

doc_comment 
      ::= "/**" "... text ..." "*/"

[rule list] 
This rule is called by

-> field_declaration
-> type_declaration

Explications

Les commentaires de documentation sont utilisés pour décrire l'utilisation et le comportement des constructeurs, méthodes, et variables. On les place la ligne précédant la déclaration de l'entité. Un utilitaire, typiquement javadoc se chargera ensuite de générer une documentation à partir du fichier source.

Exemple

class accDocumente {

    /** constante qui ne sert a rien ! */
    final static int constanteBidon = 10;
    
    /** accumulateur */
    protected int acc;
    
    /** initialise l'accumulateur */
    public accDocumente() {
        acc = 0;
    }
    
    /** ajoute la valeur a l'accumulateur */
    public void ajoute(int valeur) {
        acc += valeur;
    }
    
    /** soustrait la valeur a l'accumulateur */
    public void soustrait(int valeur) {
        acc -= valeur;
    }
    
    /** retourne la valeur de l'accumulateur */
    public int combien() {
        return acc;
    }
    
}
En cliquant ici vous pouvez voir le résultat après la génération de la documentation, avec javadoc.
Index général - Index concepts - Règles BNF
© 1996, DIP Genève, Alexandre Maret & Jacques Guyot
page générée Fri Jun 21 15:40:51 MET DST 1996