« Programmation Java/Commentaires » : différence entre les versions
Contenu supprimé Contenu ajouté
Aucun résumé des modifications |
Copié de la page "bases du langage" |
||
Ligne 1 :
<noinclude>{{Programmation Java}}</noinclude>
Un {{w|Commentaire (informatique)|commentaire}} permet d'insérer du texte qui ne sera pas compilé ni interprété.
Il sert à ajouter du texte au code source.
Ligne 11 :
Il peut aussi être utilisé pour que le compilateur ignore une partie du code : code temporaire de débogage, code en cours de développement, etc.
== Syntaxe ==
Java permet d'insérer des commentaires en utilisant deux syntaxes différentes :
*La séquence <code>//</code> permet d'insérer un commentaire sur une seule ligne, qui se termine donc à la fin de la ligne.
*La séquence <code>/*</code> permet d'insérer un commentaire sur plusieurs lignes. La séquence <code>*/</code> marque la fin du commentaire. En d'autres termes, tout ce qui est situé entre <code>/*</code> et <code>*/</code> est considéré comme faisant partie du commentaire.
Exemple :
<source lang="java">
// Commentaire sur une ligne
public class /* un commentaire au milieu de la ligne */ Exemple {
/*
Commentaire sur
plusieurs lignes
...
*/
public static void main(String[] args) {
}
}
</source>
==== Commentaire Javadoc ====
Les commentaires normaux sont totalement ignorés par le compilateur Java.
En revanche, certains commentaires sont interprétés par le générateur automatique de documentation Javadoc.
Ces commentaires commencent par la séquence <code>/**</code> et se terminent par <code>*/</code>. Le contenu décrit l'entité qui suit (classe, interface, méthode ou attribut), suivi d'une série d'attributs dont le nom commence par un arobase <code>@</code>.
La documentation générée étant au format HTML, il est possible d'insérer des balises dans la description.
Exemple :
<source lang="java">
/**
Une classe pour illustrer les commentaires Javadoc.
@author Moi :-)
*/
public class Exemple {
/**
Une méthode <b>main</b> qui ne fait rien.
@param args Les arguments de la ligne de commande.
*/
public static void main(String[] args) {
}
}
</source>
En fait, il existe un attribut Javadoc qui est pris en compte par le compilateur : l'attribut <code>@deprecated</code>. Cet attribut marque une classe, une méthode ou une variable comme obsolète. Ce qui signifie que si une autre classe l'utilise un avertissement est affiché à la compilation de cette classe.
Exemple :
<source lang="java">
/**
Une méthode obsolète. Il faut utiliser get() à la place.
@deprecated
*/
public Object getElement(int index)
{ ... }
/**
Une nouvelle méthode.
*/
public Object get(int index)
{ ... }
</source>
Cet attribut permet de modifier une bibliothèque de classe utilisée par plusieurs applications, en la laissant compatible avec les applications utilisant l'ancienne version, mais en indiquant que les anciennes classes / méthodes / variables ne doivent plus être utilisées et pourraient ne plus apparaître dans une version ultérieure.
== Syntaxe ==
| |||