Javadoc @return标签注释重复吗？

来自Oracle的建议 如何为Javadoc工具编写文档注释：

@return（参考页）

省略返回 void 的方法和构造函数的@return;将其包含在所有其他方法中，即使其内容与方法描述完全冗余。具有显式@return标记使某人更容易快速找到返回值。只要有可能，请为特殊情况提供返回值（例如，指定在提供越界参数时返回的值）。

如果你（像我一样）真的不喜欢违反DRY，那么这是javadoc ref中最重要的一行：

可以有一个只有标签部分而没有主要描述的评论。

（@see http://docs.oracle.com/javase/7/docs/technotes/tools/solaris/javadoc.html#tagsection)

因此，对于编写javadoc的简单方法是完全有效（并且有效），例如：

/**
* @return the name of the object
*/
public String getName();

所以你甚至可以写这样的东西：

/**
* @return the n-th element of the object
*
* @param n index of element to get
*/
public String get( int n );

这（在稍微了解彼此之后）在源代码中更具可读性，并且作为违反DRY的较长形式，因此更易于维护。