我正在开发一个WP主题,并使用PHPDoc注释我的PHP代码。我想添加大型代码块的版本,这样客户就知道它何时更新。
假设我发布了1.0.0的初始版本,然后在1.0.2版本中更新了一些代码。如何记录代码已更改?这是正确的吗:
/**
* Code block #1
*
* @since ThemeVersion 1.0.0
* @version 1.0.2
*/
我不确定这是使用@version的正确方式,因为另一方面,当更新后另一块代码没有更改时,我会遇到另一种情况:
/**
* Code block #2
*
* @since ThemeVersion 1.0.2
* @version 1.0.0
*/
所以不确定这是否有意义。。请告诉我你的想法。
谢谢。
您的用例是对这两个标记组合的合理使用。
因此,我希望你在代码块#1中的使用意味着:
- 该块是在主题v1.0.0中创建的
- 这个区块最后一次被Theme v1.0.2修改
(请注意,消费者使用的当前主题版本可能是v2.0.0,但这些标记值仍然意味着它们的含义——即使安装的主题是v2.0.0的,这个代码块#1最初是在v1.0.0中添加的,最后在v1.0.2中更改)
现在,在你的代码块#2上:
@since ThemeVersion 1.0.2
应该告诉我该块是在Theme v.1.0.2中首次创建的- 但
@version 1.0.0
告诉我它最后一次修改是v1.0.0…但这不可能是正确的,因为它甚至在v1.0.2之前都没有出现在代码中
(如果您将两个标记值都设置为1.0.0,那对我来说就是"块#2是在v1.0.0中创建的,还没有更改)。