Section courante

A propos

Section administrative du site

Généralité

Le langage Java support deux format de remarque. Le premier format à les syntaxes suivantes :

/* ma remarque */

ou

/* ma remarque
étalé sur plusieurs lignes
... */

Comme la seconde syntaxe le démontre on peut étirer les commentaires sur plusieurs lignes ou simplement la mettre sur une ligne, le Java n'y voit aucune différence.

Le deuxième n'affecte que la ligne courante du code source. Donc, lorsqu'on se retrouve à la ligne suivante, les instructions régulières reprennent et la remarque n'a plus court. Finalement, son format à la syntaxe suivante :

// ma remarque

Exemple

Voici un exemple typique de l'utilisation de cette fonction :

  1. public class RemarqueSamples {
  2.     public static void main(String[] args) {
  3.         /* Ceci est un commentaire n'étant pas vue */
  4.     }
  5. }

javadoc

Le langage de programmation Java supporte des commentaires (ou remarques) de documentation spéciaux, commençant par «/**» et se terminent par «*/». Ces commentaires ne sont pas réellement traités spécialement par le compilateur, mais peuvent être extraits et automatiquement transformés en documentation HTML par le programme javadoc. Voici la liste des balises les plus communes utilisé par le javadoc :

Balise Description
@author text Cette balise permet d'ajouter une entrée «Author:» contenant le texte spécifié à la documentation. Peut uniquement être utilisé avant une définition de classe. Le javadoc ignore cette balise, sauf si le paramètre de ligne de commande -author est spécifié.
@deprecatedexplanation Cette balise permet, depuis la version Java 1.1, d'indiquer que la classe, la méthode ou le champ suivant est obsolète. Le javac note ces informations dans le fichier de classe qu'il génère et émet un avertissement lorsqu'un programme utilise la fonctionnalité obsolète. Le javadoc ajoute à la documentation une entrée «obsolète» contenant l'explication spécifiée.
@exception full-classname description Cette balise permet d'ajouter une entrée «Throws:» à la documentation. L'entrée contient le nom de classe spécifié de l'exception et la description spécifiée, cette situation devenant expliquer l'importance de l'exception. Peut uniquement être utilisé avant une définition de méthode.
@param parameter-name description Cette balise permet d'ajouter le paramètre spécifié et sa description spécifiée à la section «Parameters:» de la méthode en cours. Si la description est plus longue qu'une ligne, vous pouvez continuer à la suivante. Peut uniquement être utilisé avant une définition de méthode.
@return description Cette balise permet d'ajouter une section «Returns:» contenant la description spécifiée à la documentation. Peut uniquement être utilisé avant une définition de méthode.
@see classname Cette balise permet d'ajouter à la documentation une entrée «See Also:» contenant un lien hypertexte vers la classe spécifiée. Il peut être utilisé avant les classes, méthodes ou champs.
@see full-classname Cette balise permet d'ajouter à la documentation une entrée «See Also:» contenant un lien hypertexte vers la classe spécifiée. Il peut être utilisé avant les classes, méthodes ou champs.
@see full-classname#method-name Cette balise permet d'ajouter à la documentation une entrée «See Also:» contenant un lien hypertexte vers la méthode spécifiée de la classe spécifiée. Il peut être utilisé avant les classes, méthodes ou champs.
@since version Cette balise non documentée permet, depuis la version Java 1.1, d'indiquer quand la classe, la méthode ou le champ la suivant a été ajouté à l'API. Il devrait être suivi d'un numéro de version ou d'une autre spécification de version. La version JDK 1.1 de javadoc semble ignorer cette balise.
@version text Cette balise permet d'ajouter une entrée «Version:» contenant le texte spécifié à la documentation. Peut uniquement être utilisé avant une définition de classe. Le javadoc ignore cette balise sauf si le paramètre de ligne de commande -version est spécifié.


Dernière mise à jour : Mercredi, le 3 juin 2015