使用phpDocumentor记录代码更新和日期的不同作者的方法

Question

假设一个类的原始文档如下：

/**
 * 我的自定义类
 *
 * 这个类帮助你做一些事情。它真的很棒。
 *
 * 作者：David Smith
 * 版本：1.0
 */

1. 如果我对50%的代码进行了重写，如何记录我做出的重要贡献？

2. 添加日期的最佳方式是什么？例如，代码最后一次修改的日期，我进行更新的日期，或版本更新的日期。

Answer 1

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

/**
 * 我的自定义类
 *
 * 这个类可以帮助你做一些事情。非常好用。
 *
 * 作者：David Smith
 * 版本：1.0
 *
 * 修改者：Rahul Parkar
 * 修改日期：09/11/2012
 */

此外，我还看到他们使用了两种方法来记录变更，一种是使用类似Git的方式，每个提交都有一个提交信息，另一种是使用另一个文档标签来记录变更。

Answer 2

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

如果要跟踪代码的更改（谁创建了文件？谁修改了它？），请使用你的版本控制系统。毕竟，那就是它的用途 :)