/ * (non-javadoc) signification

Question

Dupliquer possible:
Est-ce que "/ * (non-javadoc)" a un sens bien compris?

Que signifient les affirmations suivantes?

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

Answer 1

Javadoc regarde pour les commentaires qui commencent par /**. Par tradition, la méthode des commentaires qui ne sont pas destinés à faire partie de la java docs commencer par "/* (non-Javadoc)" (au moins lors de votre environnement de dev est de l'Éclipse).

De plus, évitez d'utiliser les commentaires multi-lignes à l'intérieur des méthodes. Par exemple, éviter ceci:

public void iterateEdges()
{
  int i = 0;

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

La suite est préférable:

public void iterateEdges()
{
  int i = 0;

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

La raison en est que vous avez la possibilité de commenter l'ensemble de 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 encore voir l'ancienne méthode, le comportement de mise en œuvre de la nouvelle méthode. Ceci est également utile lors du débogage (pour simplifier le code).

Answer 2

J'ai vu ce message généré par Eclipse lorsque le programmeur demande Eclipse pour ajouter un commentaire Javadoc pour un peu de code dans un endroit où la Javadoc de l'outil ne sera pas réellement utiliser il.

Un exemple courant est la mise en œuvre d'une méthode dans une interface implémentée par la classe (ce qui, dans la version 6 de Java a besoin de l' @Override annotation). Javadoc va utiliser la javadoc placé sur la méthode dans l' INTERFACE, et non celui fourni dans la mise en œuvre.

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

Answer 3

/*
 * 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 /** 
 */

Answer 4

C'est juste un commentaire normal. La note signifie que si vous créez un manuel, base de javadoc, ce texte ne sera pas ajouté.