phpDocumentor - 如何记录不同的作者更新代码和日期?

时间:2012-11-09 10:54:29

标签: documentation phpdoc code-documentation

假设一个类的原始文档如下所示:

/**
 * My custom class
 *
 * This class helps you do stuff.  It's really great.
 *
 * @author  David Smith
 * @version 1.0
 */
  1. 如果我过来并重新编写50%的代码,我该如何记录我做出了重大贡献?

  2. 添加日期的最佳方法是什么?例如上次修改代码,进行更新时,或更新版本时。

2 个答案:

答案 0 :(得分:3)

我在多年来一直工作的公司中看到的一种方法就是这样做

 /**
 * My custom class
 *
 * This class helps you do stuff.  It's really great.
 *
 * @author  David Smith
 * @version 1.0
 *
 * @modifier Rahul Parkar
 * @modifiedDate 09/11/2012
 */

另外,我看到他们使用2种方法来记录更改,一种是使用类似Git的东西,其中每次提交都有提交消息,另一种是使用另一个Doc标记来记录更改。

答案 1 :(得分:2)

我知道我并没有真正回答你的问题,但我想知道你为什么要使用@author。

要跟踪对代码的更改(谁创建了一个文件?谁更改了它?),请使用您的版本控制系统。毕竟,这就是它的用途:)