java -/*(非javadoc)含义

Question

这个问题在这里已经有了答案:

关闭 9年前。

Possible Duplicate:
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 文档一部分的方法注释以“/* (non-Javadoc)”开头(至少当您的开发环境是 Eclipse 时)。

顺便说一句，避免使用多行注释inside 方法。例如，避免这种情况:

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

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