【问题标题】:How to dynamically change the @version field from the phpdocumentor如何从 phpdocumentor 动态更改 @version 字段
【发布时间】:2014-07-23 09:46:56
【问题描述】:

我使用phpdocumentor标签来记录我的php代码类和函数,如下所示

/**
* Module for Car 
* @category Vehicle
* @version  2.0
* @since    1.0
* @link     http://api.abc.example.com/v2.0/docs/#!/car
*/

我的问题是,有没有办法动态更改 @version 和 @link 值。好像版本改变了,我不想去每个类和函数去更新@version 和@link 字段。 如果我的系统版本从 v2.0 更改为 3.0,我将不得不更改所有类和函数的文档

/**
* Module for Car 
* @category Vehicle
* @version  3.0
* @since    1.0
* @link     http://api.abc.example.com/v3.0/docs/#!/car
*/

这样做很乏味:-)。

有什么建议吗?

【问题讨论】:

  • 如果您不更改类中的任何内容,请不要更改版本号。
  • @Grumpy,感谢您的回复:-)。我的系统实际上是一个 API,所以,我用 v2.0 或 3.0 版本的 API,所以版本是指 API 版本而不是单个类或方法。但是,我在我的所有类和方法中都标记了版本,以便及时了解在哪个 API 版本上添加了哪个方法或类。
  • 在我看来,您希望获得类似于 CVS 和 SVN 所具有的“关键字扩展”的功能 (stackoverflow.com/questions/39742/…)。它的可用性取决于您使用的 VCS。

标签: php phpdoc phpdocumentor2


【解决方案1】:

许多编辑器具有replace in files 功能。您可以设置路径并简单地替换:

@version  2.0

@version  3.0

与第二个字符串相同

【讨论】:

  • 谢谢 :-),我不想使用“查找和替换”方法,因为它要求我将所有文件再次提交回源代码管理,我想避免提交大量文件只是因为更改了版本号。但是,我想在系统根级别的某个位置配置版本号并动态引用版本。
猜你喜欢
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 2011-09-29
  • 2017-10-22
  • 1970-01-01
  • 2012-03-31
相关资源
最近更新 更多