So verwenden Sie phpDocumentor, um Codeaktualisierungen und Daten für verschiedene Autoren aufzuzeichnen

Question

Angenommen, die Originaldokumentation für eine Klasse lautet wie folgt: /***Meine benutzerdefinierte Klasse** Diese Klasse hilft Ihnen dabei, etwas zu tun. Es ist wirklich großartig. **Autor: David Smith*Version: 1.0*/ Wie erfasse ich meinen wesentlichen Beitrag, wenn ich 50 % des Codes neu schreibe? Wie füge ich am besten ein Datum hinzu? Zum Beispiel das Datum, an dem der Code zuletzt geändert wurde, das Datum, an dem ich ein Update durchgeführt habe, oder das Datum, an dem die Version aktualisiert wurde.

P粉545218185 · Answer

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

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

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

P粉512526720 · Answer

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

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