web-dev-qa-db-fra.com

/ * (non-javadoc) signifie

Duplicata possible:
("/ * (non-javadoc)" a-t-il une signification bien comprise?

Que signifient les déclarations suivantes?

    /* (non-Javadoc)
     * 
     * Standard class loader method to load a class and resolve it.
     * 
     * @see Java.lang.ClassLoader#loadClass(Java.lang.String)
     */
    @SuppressWarnings("unchecked")
javasyntaxcommentsjavadoc
49
Mian Asbat Ahmad

J'ai vu ce message généré par Eclipse lorsque le programmeur demande à Eclipse d'ajouter un commentaire Javadoc à du code dans un emplacement où [EDIT: Eclipse pense] que l'outil Javadoc ne le fera pas tiliser.

Un exemple courant est l'implémentation d'une méthode dans une interface implémentée par la classe (qui en Java 6 a besoin de l'annotation @Override). Javadoc utilisera le javadoc placé sur la méthode dans le - INTERFACE , pas celle fournie dans l'implémentation.

Le reste du commentaire a probablement été écrit par une personne qui ne le savait pas.

26
Thorbjørn Ravn Andersen

Javadoc recherche les commentaires commençant par/* *. Par tradition, les commentaires de méthode qui ne sont pas destinés à faire partie des documents Java commencent par "/ * (non-Javadoc)") (au moins lorsque votre environnement de développement est Eclipse).

En passant, évitez d'utiliser les commentaires sur plusieurs lignes à l'intérieur méthodes. Par exemple, évitez ceci:

public void iterateEdges()
{
  int i = 0;

  /* 
   * Repeat once for every side of the polygon.
   */
  while (i < 4)
  {
  } 
}

Ce qui suit est préféré:

public void iterateEdges()
{
  int i = 0;

  // Repeat once for every side of the polygon.
  while (i < 4)
  {
    ++i;
  } 
}

La raison en est que vous ouvrez la possibilité de commenter toute la méthode:

/*
public void iterateEdges()
{
  int i = 0;

  // Repeat once for every side of the polygon.
  while (i < 4)
  {
     ++i;
  } 
}
*/

public void iterateEdges()
{
  // For each square Edge.
  for (int index = 0; index < 4; ++index)
  {
  }
}

Maintenant, vous pouvez toujours voir le comportement de l'ancienne méthode lors de l'implémentation de la nouvelle méthode. Ceci est également utile lors du débogage (pour simplifier le code).

26
DwB
/*
 * This is the typical structure of a multi-line Java comment.
 */

/**
 * This is the typical structure of a multi-line JavaDoc comment.
 * Note how this one starts with /** 
 */
11
Zoot