コードレビューコメントを書き込む方法
アウトライン
- 優しさ
- 明らかに、あなたの理由を述べます
- 問題の後に明確な方向性を与え、それを指摘するには、開発者が独自の意思決定との間のバランスを行うことができます
- コードを単純化や説明を追加するために、開発者を奨励するのではなく、コードは非常に複雑である理由を説明
礼儀
あなたが他の誰かのコード、優しさ、敬意を見直す際に通常、それは非常に重要である開発者のための明確かつ効果的なアドバイスを提供。この方法は、唯一のコメントで行われたコードではなく、開発者。あなたは必ずしもお勧めに従って動作するようにする必要はありませんが、あなたが何かを言うとき、負または論争のコメントは、仕様に従ったものでなければなりません。たとえば、次の
エラー：「なぜあなたはそれが場面によって複雑にする必要はありません、このような明白で複数のスレッドを使うのか？」
修正:.「履行がないので、ここでは同時使用が唯一の私は任意の実際のパフォーマンスの向上を見つけられませんでしたシステムの複雑さを増しますここではなく、複数のスレッドのシングルスレッドを使用するのが最適です。 "
理由を説明
あなただけの開発者が理解することができ、「右」の例を見つけるなぜ、時にはあなたは、このようなベストプラクティスとして、あなたが従うこと、またはあなたのコードの品質を向上させるために、あなたの目的のもう少し説明をしなければならない、あなたはそれらのコメントを書き留めておく必要がありいくつかの提案
提供のガイダンス
通常、開発者の提出の責任は監査役ではない変更を修理しました。校閲者として、あなたは、詳細な設計ソリューションやヘルプの開発者がコードを実行するべきではありません。
しかし、これは、あなたが問題の合理的な把握を指摘し、直接的な解決策との間のバランスを提供したいにもかかわらず、監査は任意のヘルプを提供してはならないという意味ではありません。ただ、問題点を指摘し、開発者がそれらの成長を助けることができ、一般的に、自分の意思決定は、監査行動も容易にすることができます。開発者はコードや査読以上のニーズを理解しているのでこれは通常、良い結果を生成します。
しかし、時には直接指示、助言、あるいはコードがより便利になります。結局のところ、コードレビューの目的は、提出が最適であるようにすることです。第二の目標は、より迅速に確認することができ、将来的に開発者のスキルを向上させることです。
受け入れられた説明
あなたは通常、あなたが理解できない説明をコード終わるために開発を依頼するとき、それは、開発者が必要となるコードがより明確に再書き込みします。時折下では、コード内のコメントを追加し、過度に複雑なコードを説明していない場合は、良い返事です。
コードを読む人のために、将来的に説明書き込み専用のコードレビューツールは便利ではありません。これは、あなただけはあまり馴染みの機能を検討しているたとえば、特定の状況下で受け入れることができ、開発者がすでに知っているあなたに、他のレビューのほとんどのいくつかを説明しようとしています。
次へ：コードレビューに負のフィードバックをどのように扱いますか