是“/ *（非javadoc）”有一个很好理解的意义？ [英] Does "/* (non-javadoc)" have a well-understood meaning?

问题描述

/ *（non-javadoc）有一个意义，除了指出源代码的读者注释块是故意不是Javadoc注释？最近我看到很多代码看起来像这样：

Does /* (non-javadoc) have a meaning, beyond pointing out to the reader of source code that a comment block is intentionally not a Javadoc comment? Lately I've seen a lot of code that looks like this:

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

这是既定的惯例吗？

推荐答案

根据信息我可以找到，这是修复的旧版本的错误JavaDoc工具（或更有可能是旧版本的Eclipse处理JavaDoc注释），不会显示覆盖父类方法的正确文档。

According to the info I could find, this was to fix a bug in older versions of the JavaDoc tool (or more likely older version of Eclipse's processing of JavaDoc comments) that would not display the correct documentation for a method that overrides the method of a parent class.

Konstantin指出，Eclipse的覆盖模板包含此文本。

As noted by Konstantin, Eclipse's override template includes this text.

这篇关于是“/ *（非javadoc）”有一个很好理解的意义？的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！