/* （non-javadoc） meaning

syntax java comments javadoc

2022-08-31 21:00:33

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

以下语句是什么意思？

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

答案 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)
  {
  }
}

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

答案 2

我见过Eclipse生成的这个消息，当程序员要求Eclipse在一个位置添加Javadoc注释到一些代码中时，Javadoc工具实际上不会使用它。

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

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