Javadoc@return标记注释是否有必要重复？
对于不改变实例状态的函数，方法的javadoc注释通常与Java-API中@return-tag的注释相同或非常相似。
boolean Collection.IsEmpty（）
- 如果此集合不包含元素，则返回true。
- 如果此集合不包含元素，则返回：true
现在我正在为许多简单的方法编写javadoc,比如getExpression（）,在这些方法中我遇到了同样的问题。我应该像在API中那样做还是不做它？
共有1个答案
对于Javadoc16，您可以使用新的combo{@return...}标记，以“避免简单情况下返回信息的重复”。
/**
* {@return the name of the object}
*/
public String getName();
等效于（仍然支持的）样式：
/**
* Returns the name of the object.
*
* @return the name of the object
*/
public String getName();
详情请访问https://bugs.openjdk.java.net/browse/jdk-8075778
-
（仅限类和接口，必需） （仅限类和接口，必需。请参见脚注1) （仅限方法和构造函数） （仅限方法） (是Javadoc 1.2中添加的同义词） （或或) （请参阅如何以及何时弃用API) 在这里，似乎被标记为“required”，即使不是这样。这在我看来很奇怪。事实上，后来在同一份文件中，我发现了以下陈述： 您可以提供一个@author标记、多个@author标记或不提供@author标记。
-
问题内容： 什么时候在方法开始时使用块注释，什么时候使用Javadoc风格的注释？ 在Java样式指南的“注释”部分中，我发现了这一点： Java程序可以有两种注释：实现注释和文档注释。实现注释是在C ++中发现的，由，和// 分隔。文档注释（称为“文档注释”）仅适用于Java，并以分隔。可以使用javadoc工具将Doc注释提取到HTML文件中。 实现注释用于注释掉代码或有关特定实现的注释。Do
-
问题内容： 在我的项目中，我们使用了许多批注，这些批注在javadoc API文档中非常有用。 有谁知道在生成的javadocs中包含注释的简单方法？我不想编写自己的javadoc插件。有什么解决办法吗？ 问题答案： 参见java.lang.annotation.Documented 表示默认情况下，javadoc和类似工具将记录带有类型的注释。此类型应用于注释其注释会影响其客户端对已注释元素的使
-
我的目标是将以前使用Spring Boot 1.3开发的Spring Boot应用程序迁移到最新的Spring Boot 1.4版本。该应用程序由几个maven模块组成，其中只有一个包含用SpringBootApplication注释的类。 迁移的一部分是使用WebMvcTest注释来有效地测试控制器，这里我遇到了一个问题。 考虑Spring Boot github页面中的一个示例应用程序<代码>
-
关于java.lang.enum.values（）方法，我有一个非常具体的问题。 我也很好奇为什么不能重写。我在其他问题上读到“它是由编译器生成的”。但有人能更精确一点吗？它似乎是从枚举的名称生成的，但它没有解释原因。
-
问题内容： 在界面中添加Javadoc注释并在实现中添加非Javadoc注释是否正确？ 当您自动生成注释时，大多数IDE都会为实现生成非JavaDoc注释。具体方法不应该有描述吗？ 问题答案： 对于仅实现（不是覆盖）的方法，请确定为什么不这样做，尤其是如果它们是公共的。 如果您处于压倒一切的情况，并且打算复制任何文本，那么绝对不能。复制是导致差异的必经之路。结果，用户将基于检查父类型还是子类型中的