0

我正在开发一个 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
 */

所以不确定这是否有意义..请让我知道你的想法。

谢谢你。

4

1 回答 1

0

您的用例是对两个标签组合的合理使用。

因此，我希望您在代码块 #1 中的使用意味着：

  • 这个块是在 Theme 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 中创建的，尚未更改）。

于 2014-10-15T21:44:03.253 回答