私は他の著者が書いたものを修正しているクラスがあります。元の著者に適切なクレジットが与えられていることを確認しながら、ドキュメントに自分の変更を加える正しい方法は何か疑問です。バージョン管理をリセットするか、続行する必要がありますか?元のPHPDocコメントに追加する必要がありますか、私は自分の別のブロックを作成する必要がありますか?私は別の著者から変更しているPHPクラスにどのようにコメントしますか?
3
A
答えて
0
あなたが更新のdocblock 情報値ではなく、あなたが修正を行った記録をする方法を求めているようにそれは私に聞こえます。その場合は、追加情報をdocblockの説明に追加し、新しい@タグを適用する場合は追加してください。
依然として著作権を強調したい場合は、@authorタグを使用してオリジナルと自分自身を表示します。
3
git、mercurial、subversionなどのバージョン管理システムを使用して、コードに必要な処理を行う必要があります。あなたのコミットのログエントリは誰が何を変更したのかを識別します。
あなたがインラインドキュメントのみを変更している場合は、変更ログに行えたことを示す行を追加します。あなたはバージョン番号にバンプするかもしれませんが、議論の余地があります。
関連する問題
- 1. PHPは、メタデータ欠落しているタイトル、著者、コメント、アーティスト
- 2. 投稿者をJavaクラスのコメントでどのように設定しますか?
- 3. 別のクラスの変数を変更するにはどうしたらいいですか? (レベルカウントなど)
- 4. 私は別のクラスからクラスのメンバを持ってしようとしています別の
- 5. Googleのドキュメントはどのようにコメントしていますか?
- 6. PyCharmの著者変数を変更するには
- 7. 私はどのようにしてsubversion.confにコメントできますか?
- 8. Wordpressの著者のアーカイブフィードのタイトルを変更するには?
- 9. アクションのCCスピードを別のクラスから変更しますか?
- 10. 私はどのようにしてクラス内のIDをターゲットにしますか?
- 11. 著者が私のレポにコミットしたかのようにgit patchを適用するには?
- 12. PHP IteratorIteratorクラスはどのように機能しますか?
- 13. 著者名でWordPressのアーカイブを入手するにはどうしたらいいですか?
- 14. PHP:コメントはどのようにスキップされますか?
- 15. PHPのクラスに含まれるファイルに変数を渡すにはどうしたらいいですか?
- 16. WordPressの著者プロフィールページへのコメント
- 17. PNGは著者、カメラモデルなどのメタデータフィールドをサポートしていますか?
- 18. WP Rest API vs - 著者IDをv2から取得するにはどうすればよいですか?
- 19. WordPressの著者以外のコメントが投稿されたときに、他のユーザーはどのように更新できますか?
- 20. 水銀で著者を変更する
- 21. 私はどのようにプライベートプロパティをクラス内の配列としてPHP ext内に作成しますか
- 22. サブクラスの変数をスーパークラスからどのように変更しますか?
- 23. どのように私はすべての動的テキストボックスからクラスを使用してPHPで値を取得
- 24. 別のクラスの変数にアクセスするにはどうしたらいいですか?
- 25. しばらく待ってから変数を変更するにはどうしたらいいですか?
- 26. 私は次のように私のJavaクラスから文字列変数を渡すようにしようとしています
- 27. Angular2クラス内のデータの変更をどのようにリッスンしますか?
- 28. のjQuery/PHP:どのように私は別のウェブサイトからID /クラスによって任意のHTMLコンテンツをロードします
- 29. 私のテーマのfunctions.phpからプラグインの機能を変更するにはどうしたらいいですか?
- 30. 管理者のウェブページからウィンドウスケジューラタスクの日付を変更するにはどうすればよいですか?