应该如何@version在PHPDoc的使用吗?

问题描述 投票:-1回答:1

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

难道我就在我的理解是@version可以在一个项目中多次使用。

在上面的链接的文档建议,以便与声明“的@version标签可以用于指示结构元素的当前版本。”

因此,例如,在一个插件,主要插件本身可能是1.0.0版本,但后来一类的插件可能是3.0.0版本。如果是的话请问@since直接关系到以前的@version标签使用?

php phpdoc
1个回答
1
投票

你是正确的“的@version可以在一个项目中多次使用”。标签是故意灵活,可以从一个极端(总包的版本,因此所有的标签显示相同的值)中使用了另一个极端(每一个类/方法/功能/不管有它自己的版本号和变更历史,因此在V1.2.3一类可能有十个方法均呈现自己不同的版本号)。但一般情况下,我不相信我所见过其中使用任何更精细比在“安装库/封装/应用级”版本的情况下。

关于@Since标签......在任何风格你使用@version标签对于给定的元素,该@Since标签表示该元素首次推出的版本号。在这一个变化是,你使用@Since标签就像一个更新日志,这样的话你有相同的元素多@Since标签(见dump()功能例子在这里 - http://docs.phpdoc.org/references/phpdoc/tags/since.html)。

我在如何使用这些标签建议: - 的“版本”是一个软件包/库/应用程序的整体发行版本的这一切在一个版本控制库是为记 - 我只会把@version标签文件级文档块,类级别的文档块,和独立功能文档块 - 我只会用@Since标签上的API级别的类和方法

这将是很容易过度使用这些标签,从而使标签的噩梦值的维护。

© www.soinside.com 2019 - 2024. All rights reserved.