当前位置: 首页 > 知识库问答 >
问题:

JavaDoc中是否需要author标记?

燕星鹏
2023-03-14
  • @author(仅限类和接口,必需)
  • @version(仅限类和接口,必需。请参见脚注1)
  • @param(仅限方法和构造函数)
  • @return(仅限方法)
  • @exception(@throws是Javadoc 1.2中添加的同义词)
  • @参见
  • @自
  • @serial(或@serialfield@serialdata)
  • @deprecated(请参阅如何以及何时弃用API)

在这里,@author似乎被标记为“required”,即使@return不是这样。这在我看来很奇怪。事实上,后来在同一份文件中,我发现了以下陈述:

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

共有1个答案

穆宾白
2023-03-14

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

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

它不是任何东西的“官方来源”,除非你在甲骨文工作。

 类似资料:
  • 问题内容: 我想知道创建Javadocs时的最佳实践。我有一个包含许多文件的项目。代码已由许多开发人员创建。每个文件都有一个注释,因此很明显谁创建了一个特定的类。 但是,当其他一些开发人员将新代码添加到文件中,对其进行修改等时,他应该如何告知团队的其他成员他已经创建了一些新功能或已经修改了现有代码?换句话说,我们应该如何“使Javadocs与现实兼容”?;) 将他的名字添加到现有标签中?然后,如果

  • 问题内容: 我想知道是否有必要使用完。该标记的信息,这是一个样式表-所以就我而言,实际上并没有添加任何东西。 HTML唯一使用的样式表格式仍然是CSS,因此对浏览器“说”什么?某些网站似乎添加了属性,而其他网站则没有。 那么,什么是使用的元素,是有必要包括它? 问题答案: HTML5规范不是必需的,但对于旧版本的HTML是必需的。 HTML 4 W3.org规范 Type代表样式表的MIME类型。

  • 对于不改变实例状态的函数,方法的javadoc注释通常与Java-API中@return-tag的注释相同或非常相似。 boolean Collection.IsEmpty() 如果此集合不包含元素,则返回true。 如果此集合不包含元素,则返回:true 现在我正在为许多简单的方法编写javadoc,比如getExpression(),在这些方法中我遇到了同样的问题。我应该像在API中那样做还是

  • OKHTTP4.0.0是否有意与jvm目标1.6不兼容?从OKHTTP3.12.0升级到4.0.0,我遇到以下构建失败。 在进一步的检查中,我发现根本原因是接口有一个静态方法(伴侣对象中的函数)。升级指南没有提到这种向后不兼容,这让我认为这是无意的。

  • 问题内容: 我想在我的JavaScript代码中包含几个JSON文件,这些文件与JavaScript源文件位于同一目录中。 如果我想包含另一个JavaScript文件,可以直接使用。现在,我正在使用和获取JSON,我认为这是执行此操作的丑陋方法。 是否有类似的要求,使我能够加载JSON文件? 问题答案: 从节点v0.5.x开始,是的,您可以像需要js文件一样要求JSON。 在ES6中:

  • 随着新的工具栏小部件的引入和AppCompat(android.support.v7.widget.Toolbar)版本的推出,是否还需要调用setSupportActionbar(工具栏)?或者调用setSupportActionbar有什么好处吗;现在我们可以设置标题、子标题、导航图标、导航图标单击侦听器(getSupportActionBar()。直接在工具栏上设置DisplayHomeAs