Comment utiliser phpDocumentor pour enregistrer les mises à jour du code et les dates de différents auteurs

Question

Supposons que le document original d'un cours soit le suivant :

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

1. Si je réécris 50% du code, comment enregistrer ma contribution importante ?

2. Quelle est la meilleure façon d'ajouter des dates ? Par exemple, la date à laquelle le code a été modifié pour la dernière fois, la date à laquelle j'ai effectué une mise à jour ou la date à laquelle la version a été mise à jour.

Answer 1

Une approche que j'ai vue dans les entreprises pour lesquelles j'ai travaillé au fil des ans est de procéder comme suit :

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

De plus, j'ai également vu qu'ils utilisaient deux méthodes pour enregistrer les modifications, l'une consiste à utiliser une méthode de type Git où chaque validation a un message de validation, et l'autre consiste à utiliser une autre balise de document pour enregistrer les modifications.

Answer 2

Je sais que je n’ai pas vraiment répondu à votre question, mais j’aimerais savoir pourquoi vous utilisez toujours @author.

Si vous souhaitez suivre les modifications apportées à votre code (qui a créé le fichier ? Qui l'a modifié ?), utilisez votre système de contrôle de version. Après tout, c'est à ça que ça sert :)