如何在phpDoc中使用@version?

时间:2019-01-22 08:46:45

标签: php phpdoc

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

我理解@version可以在项目中多次使用吗?

上面链接中的文档建议使用这样的语句:“ @version标签可用于指示结构元素的当前版本。”

例如,在一个插件中,主插件本身可以是1.0.0版,但是该插件的类可以是3.0.0版。如果是这样,@since是否直接与先前使用的@version标签相关?

1 个答案:

答案 0 :(得分:1)

您正确的说法是“ @version可以在项目中多次使用”。标签是故意灵活的,可以在一个极端(整个软件包的版本,因此所有标签都显示相同的值)到另一个极端(每个单一类/方法/函数/都有其自己的版本#和更改)中使用历史,因此v1.2.3的类可以有十个方法,它们都显示各自不同的版本号。但总的来说,我认为我从未见过比“可安装库/包/应用程序级别”更细粒度地使用该版本的情况。

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

我对如何使用这些标签的建议: -“版本”是软件包/库/应用程序的整体发行版本,所有版本都位于一个版本控制存储库中 -我只会将@version标签放在文件级文档块,类级文档块和独立函数文档块中 -我只会在 API级类和方法

上使用@since标记

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