JavaDoc中是否需要author标记？_Java_Javadoc

JavaDoc中是否需要author标记？

java

JavaDoc中是否需要author标记？,java,javadoc,Java,Javadoc,不管常规/最佳实践如何（据我所知，许多人嘲笑@author是不好的实践），而是依赖官方来源，JavaDoc中是否需要@author标记在调查这个问题时，我查阅了Oracle自己的文档（这也是Google搜索“javadoc标记”时的第一个结果）在“标签顺序”一节中，他们说：按以下顺序包括标记： @author（仅限类和接口，必填） @version（仅限类和接口，必填项。请参见脚注1） @param（仅限方法和构造函数） @return（仅限方法） @exception（@throws是

不管常规/最佳实践如何（据我所知，许多人嘲笑

@author

是不好的实践），而是依赖官方来源，JavaDoc中是否需要

@author

标记

在调查这个问题时，我查阅了Oracle自己的文档（这也是Google搜索“javadoc标记”时的第一个结果）

在“标签顺序”一节中，他们说：

按以下顺序包括标记：

```
@author
```
（仅限类和接口，必填）
```
@version
```
（仅限类和接口，必填项。请参见脚注1）
```
@param
```
（仅限方法和构造函数）
```
@return
```
（仅限方法）
```
@exception
```
（
```
@throws
```
是Javadoc1.2中添加的同义词）
```
@请参见
```
```
@自
```
```
@serial
```
（或
```
@serialField
```
或
```
@serialData
```
）
```
@已弃用
```
（请参阅如何以及何时弃用API）

在这里，似乎

@author

被标记为“必需”，即使像

@return

这样的东西没有被标记。这对我来说似乎很奇怪。事实上，我后来在同一份文件中发现了以下陈述：

您可以提供一个@author标记、多个@author标记或不提供@author标记标签

在我看来，这完全是自相矛盾的。如果您不能提供任何

@author

标记，那么它肯定不是“必需的”

我是否误读了一些东西，或者这只是一个写得很糟糕的文档？

您引用的文档是一个样式指南，而不是Javadoc规范：

本文档描述了我们在Oracle Java软件编写的Java程序文档注释中使用的样式指南、标记和图像约定

它不是任何东西的“官方来源”，除非您在Oracle工作。

您引用的文档是样式指南，而不是Javadoc规范：

本文档描述了我们在Oracle Java软件编写的Java程序文档注释中使用的样式指南、标记和图像约定

它不是任何东西的“官方来源”，除非你在Oracle工作。

我要说的是，文档编写得很糟糕

下一段说：

@author标记并不重要，因为它在生成API规范，因此只有那些查看源代码。（版本历史记录也可用于为内部目的确定贡献者。）

此外，这些技术说明不在哪里？我看不到一份声明，声明它是必需的。

我想说的是，文档写得很糟糕

下一段说：

@author标记并不重要，因为它在生成API规范，因此只有那些查看源代码。（版本历史记录也可用于为内部目的确定贡献者。）

此外，这些技术说明不在哪里？我可以看到一个声明，声明这是必需的

“许多人嘲笑@author是一种糟糕的做法……”我从来没有听到过有人这样说。虽然我不知道有谁认为

@author

是必需的，但我认识的每一个重视javadoc的人似乎都很欣赏在对类进行基本修改之前能够咨询原始作者的价值。@VGR例如，在这里它被描述为“不需要的噪音”：@Kidbura所以一个答案就足以抵消所有关于责任、审计跟踪、谁做了什么以及何时做了什么的常识？拜托，这个答案是错的。@author标记比版本控制有用得多。而且它并不意味着取代版本控制。“许多人嘲笑@author是一种糟糕的做法……”我从来没有听过有人这么说。虽然我不知道有谁认为

@author