Commentaires

images/whitebelt.png

Il y a trois catégories de commentaires :

   // commentaire sur une ligne
   // texte neutralisé jusqu'au retour à la ligne

   /* commentaire à l'intérieur du code */ int y = x + z ;

Catégorie très importante : les commentaires de documentation

documentation d’un méthode dans les librairies standard et le code source correspondant:

  /**
     * Translates a <tt>long</tt> unscaled value and an
     * <tt>int</tt> scale into a <tt>BigDecimal</tt>.  This
     * &quot;static factory method&quot; is provided in preference to
     * a (<tt>long</tt>, <tt>int</tt>) constructor because it
     * allows for reuse of frequently used <tt>BigDecimal</tt> values..
     *
     * @param unscaledVal unscaled value of the <tt>BigDecimal</tt>.
     * @param scale scale of the <tt>BigDecimal</tt>.
     * @return a <tt>BigDecimal</tt> whose value is
     *          <tt>(unscaledVal &times; 10<sup>-scale</sup>)</tt>.
     */
    public static BigDecimal valueOf(long unscaledVal, int scale) {
   // il y a du code Java ici
    }

On notera dans les commentaires de documentation: