/ *(非javadoc)含义

可能重复:
“/ *(非javadoc)”是否有很好理解的含义?

以下表述是什么意思?

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

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

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

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

Javadoc寻找以/ * *开头的注释。 按照惯例,不打算成为Java文档一部分的方法注释以“/ *(非Javadoc)”开头(至less当你的开发环境是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) { } } 

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

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

这只是一个正常的评论。 这个说明的意思是,如果你创build一个手册,javadoc的基础,这个文本将不会被添加。