JavaDoc中是否需要author标签?

时间:2016-11-16 23:42:57

标签: java javadoc

无论常见惯例/最佳实践(我知道很多人都认为@author是不良做法),而是依赖官方来源,JavaDoc中是否需要@author标记?

调查这个问题,我在http://www.oracle.com/technetwork/articles/java/index-137868.html查看了Oracle自己的文档(这也是Google搜索'javadoc标签'时的第一个结果)。

在一个名为“标签顺序”的部分中,他们说:

  

按以下顺序包含标签:

     
      
  • @author(仅限类和接口,必需)
  •   
  • @version(仅限类和接口,需要。见脚注1)
  •   
  • @param(仅限方法和构造函数)
  •   
  • @return(仅限方法)
  •   
  • @exception@throws是Javadoc 1.2中添加的同义词)
  •   
  • @see
  •   
  • @since
  •   
  • @serial(或@serialField@serialData
  •   
  • @deprecated(请参阅如何以及何时弃用API)
  •   

似乎@author被标记为“必需”,即使@return之类的内容不是。这对我来说似乎很奇怪。实际上,后来在完全相同的文档中我发现了以下声明:

  

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

在我看来,这是一个完全矛盾。如果您不能提供@author标签,那肯定不是“必需”!

我是否误读了某些内容,或者这只是写得不好的文档?

2 个答案:

答案 0 :(得分:3)

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

  

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

它不是官方来源'对于任何事情,除非你在甲骨文工作。

答案 1 :(得分:1)

我会说写得不好的文件。

下一段说:

  

@author标记并不重要,因为它不包括在内   生成API规范,因此只有那些人才能看到它   查看源代码。 (版本历史记录也可用于   为内部目的确定贡献者。)

此外,我没有看到这些技术说明在哪里可以看到声明需要http://docs.oracle.com/javase/8/docs/technotes/tools/windows/javadoc.html#javasourcefiles