/* （非 javadoc）含义

Question

可能的重复：
“/*（非javadoc）”是否具有易于理解的含义？

下面的语句是什么意思？

    /* (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，而不是实现中提供的 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 手册基础，则不会添加此文本。