Wie würde ich eine PHP-Klasse kommentieren, die ich von einem anderen Autor modifiziere?

Question

Es gibt eine Klasse, die ich modifiziere, die ein anderer Autor geschrieben hat. Ich frage mich, was ist der richtige Weg, um meine Änderungen an der Dokumentation hinzuzufügen, während Sie sicherstellen, dass der ursprüngliche Autor die richtige Kredit gegeben wird. Soll ich die Versionierung zurücksetzen oder fortsetzen? Sollte ich zu den ursprünglichen PHPDoc-Kommentaren hinzufügen oder sollte ich meinen eigenen separaten Block erstellen?

Answer 1

Es klingt für mich wie Sie fragen, wie Sie sollten Update die Informations Wert des Docblock, anstatt Datensatz, den Sie Änderungen vorgenommen haben. Wenn ja, fügen Sie einfach Ihre zusätzlichen Informationen in die Beschreibung des Docblocks ein und fügen Sie ggf. neue @ Tags hinzu.

Wenn Sie die Autorenschaft immer noch hervorheben möchten, verwenden Sie @author-Tags, um die Originale und sich selbst anzuzeigen.

Answer 2

Sie sollten ein Versionskontrollsystem wie git, mercurial oder subversion verwenden und alles tun, was zum Code benötigt wird. Protokolleinträge in Ihren Commits geben an, wer was geändert hat.

Wenn Sie nur die Inline-Dokumentation ändern, fügen Sie dem Changelog eine Zeile hinzu, die angibt, was Sie getan haben. Sie könnten die Versionsnummer stoßen, aber das ist fraglich.