/* (non-javadoc) meaning

JavaSyntaxCommentsJavadoc

Java Problem Overview


> Possible Duplicate:
> Does “/* (non-javadoc)” have a well-understood meaning?

What does the following statements mean?

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

Java Solutions


Solution 1 - Java

Javadoc looks for comments that start with /***. By tradition, method comments that are not intended to be part of the java docs start with "/ (non-Javadoc)" (at least when your dev environment is Eclipse).

As an aside, avoid using multi-line comments inside methods. For example, avoid this:

public void iterateEdges()
{
  int i = 0;

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

The following is preferred:

public void iterateEdges()
{
  int i = 0;

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

The reason is that you open the possibility to comment out the entire method:

/*
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)
  {
  }
}

Now you can still see the old method's behaviour while implementing the new method. This is also useful when debugging (to simplify the code).

Solution 2 - Java

I have seen this message generated by Eclipse when the programmer asks Eclipse to add a Javadoc comment to some code in a location where [EDIT: Eclipse thinks] the Javadoc tool will not actually use it.

A common example is the implementation of a method in an interface implemented by the class (which in Java 6 needs the @Override annotation). Javadoc will use the javadoc placed on the method in the INTERFACE, not the one provided in the implementation.

The rest of the comment was most likely written by a person that did not know this.

Solution 3 - Java

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

Solution 4 - Java

It's just a normal comment. The note means, if you create a manual, base of javadoc, this text won't be added.

Attributions

All content for this solution is sourced from the original question on Stackoverflow.

The content on this page is licensed under the Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) license.

Content TypeOriginal AuthorOriginal Content on Stackoverflow
QuestionMian Asbat AhmadView Question on Stackoverflow
Solution 1 - JavaDwBView Answer on Stackoverflow
Solution 2 - JavaThorbjørn Ravn AndersenView Answer on Stackoverflow
Solution 3 - JavaZootView Answer on Stackoverflow
Solution 4 - JavaReporterView Answer on Stackoverflow