使用phpDocumentor記錄程式碼更新和日期的不同作者的方法

Question

假設一個類別的原始文檔如下：

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

1. 如果我對50%的程式碼進行了重寫，如何記錄我所做的重要貢獻？

2. 新增日期的最佳方式是什麼？例如，程式碼最後一次修改的日期，我進行更新的日期，或版本更新的日期。

Answer 1

我在多年來工作的公司中看到的一種方法是這樣做：

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

此外，我還看到他們使用了兩種方法來記錄變更，一種是使用類似Git的方式，每個提交都有一個提交信息，另一種是使用另一個文檔標籤來記錄變更。

Answer 2

我知道我並沒有真正回答你的問題，但我想知道你為什麼還在使用 @author。

如果要追蹤程式碼的變更（誰建立了檔案？誰修改了它？），請使用你的版本控制系統。畢竟，那就是它的用途 :)