コードの健全性: 礼儀正しいレビュー == 役立つレビュー
2019年12月2日月曜日
Reviewer Don’t:
Why are you using this approach?
You’re adding unnecessary complexity. 訳: なぜこのような手法を採用したのでしょう。 不必要に複雑にしようとしています。 | Reviewer Do:
This concurrency model appears to
be adding complexity to the system without any visible performance benefit. 訳: この並行モデルは目に見えた性能改善を 特にもたらすわけでもなくシステムをより複雑に しているように思えます。 |
レビュアーとして:
- 推奨: 具体的で実現可能なフィードバックを提供する。具体的なアドバイスがない場合は、作成者がその決定を下した理由について尋ねるのもよいでしょう。
Reviewer Don’t: I don’t understand this.
訳: 意味がわかりません
Reviewer Do: If this is an optimization, can you
please add comments?
訳: ここのコードが最適化のためのものなら
その旨コメントを追加してください。
- 推奨: あまりに細かいことや必要性が低いコメントは、明確に区別できるようにする。たとえば、「Nit」(些細な指摘)や「Optional」(省略可能)などの印をつけます。これにより、作成者がレビュアーの意図をはっきりと理解できるようになります。
作成者として:
- 推奨: フィードバックを受けたら、コードについて明確に説明する、またはレビュアーのコメントに回答する。そうしないと、フィードバックを受けてコードの改善を行う能力に欠けると見なされる可能性があります。
Author Don’t: That makes sense in some cases but
not here.
訳: フィードバックの内容があてはまる場合
もありますが、今回は違うと思います。
Author Do: I added a comment about why
it’s implemented that way.
訳: なぜこのように実装したかコメントを
追加しました。
- 推奨: フィードバックに賛同できない場合は、自分のアプローチの利点を説明します。それでも合意が得られない場合は、コードレビューにおける不一致を解消するための Google のガイダンスに従います。
Reviewed by Yoshifumi Yamaguchi - Developer Relations Team