@version 应该如何在 phpDoc 中使用?

How should @version be used in phpDoc?

我一直在阅读 phpDoc 和代码注释。

我的理解是否正确 @version 可以在一个项目中多次使用。

上面 link 中的文档建议使用 "The @version tag can be used to indicate the current version of Structural Elements."

语句

因此,例如在插件中,主插件本身可能是 1.0.0 版,但该插件的 class 可能是 3.0.0 版。如果是,@since 是否与之前使用的 @version 标签直接相关?

你是正确的 "the @version can be used multiple times in a project"。标签是故意灵活的,可以从一个极端(整个包的版本,所以所有标签显示相同的值)到另一个极端(每个 class/method/function/whatever 都有自己的版本号和更改历史,所以 v1.2.3 的 class 可能有十个方法都显示自己不同的版本号)。但是,总的来说,我认为我从未见过比 "installable library/package/application level".

更精细地使用该版本的情况。

关于@since 标签...无论您以何种方式对给定元素使用@version 标签,@since 标签都代表首次引入该元素的版本#。对此的一种变体是您像更改日志一样使用 @since 标记,因此您在同一元素上有多个 @since 标记(参见此处的 dump() 函数示例 -- http://docs.phpdoc.org/references/phpdoc/tags/since.html)。

我对如何使用这些标签的建议: - 'version' 是 package/library/application 的整体发布版本,表示为所有版本都在一个版本控制存储库中 - 我只会将@version 标签放在文件级文档块、class 级文档块和独立函数文档块中 - 我只会在 API-level classes 和 methods

上使用 @since 标签

很容易过度使用这些标签,从而使标签值的维护成为一场噩梦。