/ *（非javadoc）含义

Question

  

可能重复：
  Does “/* (non-javadoc)” have a well-understood meaning?

以下陈述是什么意思？

    /* (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会查找以/ * *开头的评论。 按照惯例，不打算成为java文档一部分的方法注释以“/ *（非Javadoc）”开头（至少当您的开发环境是Eclipse时）。

另外，请避免在方法中使用多行注释。例如，避免这样：

public void iterateEdges()
{
  int i = 0;

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

以下是首选：

public void iterateEdges()
{
  int i = 0;

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

原因是你可以注释掉整个方法：

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

现在，您仍然可以在实现新方法时看到旧方法的行为。这在调试时也很有用（为了简化代码）。

Answer 2

当程序员要求Eclipse将一个Javadoc注释添加到[编辑：Eclipse认为] Javadoc工具实际上不会使用的位置的某些代码时，我看到了Eclipse生成的这条消息。

一个常见的例子是在类实现的接口中实现一个方法（在Java 6中需要@Override注释）。 Javadoc将使用放置在 INTERFACE 中的方法的javadoc，而不是实现中提供的方法。

评论的其余部分很可能是由一个不知道这一点的人写的。

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

这只是一个正常的评论。该注释表示，如果您创建一个javadoc的手册，则不会添加此文本。