机构的 Javadoc 标记答案

【问题标题】：Javadoc tag for the institution机构的 Javadoc 标记
【发布时间】：2014-11-24 02:49:48
【问题描述】：

我不确定是否适合使用它，但是否有一个 Javadoc 标记用于工作的公司/机构/组织？类似于@author。

【问题讨论】：

【解决方案1】：

here 提供了受支持标签的完整列表。如您所见，作者的组织/机构没有标签。

【讨论】：

【解决方案2】：

对此没有标准标记，但您始终可以使用 Javadoc 的 -tag 选项定义自己的标记：http://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html#tag

这适用于@author 等简单标签，因此可能足以满足您的要求。

【讨论】：

【解决方案3】：

指南How to Write Doc Comments for the Javadoc Tool 有一个引用实体的示例，并在包级别使用@author 标签。

在社区流程的这些日子里，新 API 的开发是一个开放的、共同的努力，JSR 可以被认为是包级别的新包的作者。例如，新包 java.nio 在包级别具有“@author JSR-51 专家组”。

似乎没有任何限制，作者标签只能包含一个名称。所以另一种选择是简单地将信息添加到实际作者，例如@author John Doe (Acme Corporation)。

【讨论】：