“/ *(非javadoc)”是否有一个易于理解的含义?

时间:2011-01-04 19:04:37

标签: java comments javadoc

/* (non-javadoc)是否有意义,除了向源代码的读者指出注释块有意不是Javadoc注释?最近我看到很多代码看起来像这样:

/*
 * (non-javadoc)
 *
 * This method converts widgets to gizmos
 */
public Foo bar() {
   ...

这是某种既定惯例吗?如果是这样,它是什么意思(超出明显的字面含义)以及何时使用?

2 个答案:

答案 0 :(得分:19)

根据info I could find,这是为了修复旧版JavaDoc工具中的错误(或者更可能是旧版本的Eclipse JavaDoc注释处理),这些错误无法显示覆盖方法的正确文档父类的方法。

如Konstantin所述,Eclipse的覆盖模板包含此文本。

答案 1 :(得分:16)

除了作为评论之外,它没有确定的含义。格式化是常见的Eclipse代码格式化模板的结果,这解释了它的通用性。