“/*(非javadoc)”是否具有很好理解的含义?

2022-09-01 14:30:51

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

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

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


答案 1

根据我能找到的信息,这是为了修复旧版本的JavaDoc工具(或者更可能是Eclipse处理JavaDoc注释的旧版本)中的一个错误,该错误不会显示覆盖父类方法的方法的正确文档。

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


答案 2

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


推荐