当前位置: 首页 > 面试题库 >

javadoc:@version和@since

谭琛
2023-03-14
问题内容

是否有理由将两者都包括在内@version@since作为类的一部分?

它们似乎是互斥的。

另外,它们的含义%I%%G% 含义以及如何设置/使用它们?

 @version %I%, %G%

谢谢


问题答案:

@version标签应该是有问题的释放或文件的最新版本。的%I%%G%语法是宏的源代码控制软件将与文件的当前版本和日期替换文件时签出。

@since标记应用于定义您添加了方法,类等的版本。这是向其他开发人员的提示,他们只有在针对特定版本的软件包运行时才应使用该方法。如果您将代码作为打算供其他人使用的库进行发布,我会考虑这些文档中非常重要的部分。



 类似资料:
  • 有没有人能够让javadoc工作,而不必将源代码版本更改为1.8(如其他论坛所建议的)?我正在使用JDK v11。0.5,该问题仍然存在(JDK 12也存在)。 编辑:此错误源于maven,由maven javadoc插件引发。即使使用<代码>

  • 我安装了多个JDK。 在我的build.gradle中,我设置,以确保使用正确的sourceCompatibility。这很好用。 它编译并运行时没有任何警告(),但不会更改任何内容,也不会出现在中。

  • 签名 m.version 参数 类型 是否必须 描述 返回 String 返回版本号 工作原理 m.version 属性会返回当前 Mithril 的版本号。 版本号使用 semver 规范,格式为 “0.0.0”,第一个数字是主板本号,第二个数字是次版本好,第三个数字是修订版本号。 当有向下不兼容的 API 更改时,更新主版本号 当添加新功能,且向下兼容时,更新次版本号 当修复 bug,且向下兼

  • 返回当前 Rax core 的版本。 API version: string 示例 import { version } from 'rax'; console.log('version: ', version); // ==> version: 1.0.4

  • 藐视: 描述版本信息。 概述 @version标签后面的文本将被用于表示该项的版本。 例子 例如,使用@version标签: /** * Solves equations of the form a * x = b. Returns the value * of x. * @version 1.2.3 * @tutorial solver */ function solver(a, b

  • 问题内容: 一些编译器对JavaDoc和源代码注释中的非ASCII字符失败。关于Java源文件中的Unicode,当前(Java 7)和将来(Java 8及更高版本)的做法是什么?IcedTea,OpenJDK和其他Java环境之间是否有区别,语言规范规定了什么?是否应使用HTML &escape; 在JavaDoc中对所有​​非A​​SCII字符进行转义 。 类似的代码?但是,Java //注释