私は別の著者から変更しているPHPクラスにどのようにコメントしますか？

Question

私は他の著者が書いたものを修正しているクラスがあります。元の著者に適切なクレジットが与えられていることを確認しながら、ドキュメントに自分の変更を加える正しい方法は何か疑問です。バージョン管理をリセットするか、続行する必要がありますか？元のPHPDocコメントに追加する必要がありますか、私は自分の別のブロックを作成する必要がありますか？

Answer 1

あなたが更新のdocblock 情報値ではなく、あなたが修正を行った記録をする方法を求めているようにそれは私に聞こえます。その場合は、追加情報をdocblockの説明に追加し、新しい@タグを適用する場合は追加してください。

依然として著作権を強調したい場合は、@authorタグを使用してオリジナルと自分自身を表示します。

Answer 2

git、mercurial、subversionなどのバージョン管理システムを使用して、コードに必要な処理を行う必要があります。あなたのコミットのログエントリは誰が何を変更したのかを識別します。

あなたがインラインドキュメントのみを変更している場合は、変更ログに行えたことを示す行を追加します。あなたはバージョン番号にバンプするかもしれませんが、議論の余地があります。