※本記事は、ChatGPTによる意訳+翻訳を活用し、レイアウト調整したものです。
※元記事を見て、内容がズレていないか査読するようにしています。
※感想は、オリジナルです。
原文
意訳+要約
コード品質向上のテクニック：第51回 確信的な質問
コードレビューでは、質問形式のコメントが誤解を招くことが多く、意図が伝わりにくい点が問題視されています。レビューコメントは「要求」「提案」「質問」のいずれかを明確に区分し、適切なフレーズやタグを用いるべきとされています。
主なポイント
- 質問形式のコメントは意図を明確に伝えにくい。
- コメントは「要求」「提案」「質問」のどれかを意識して分類。
- 明確なフレーズ（例:「してください」「方法もあります」）やタグを活用する。
検証
意図の伝え方について調査
コードレビューとは？ 手順や注意点、実施のメリットまで詳しく解説！ - エンジニアtype | 転職type
レビューコメントにラベルをつけるだけで開発効率があがって幸せになれそうな話 #Git - Qiita
コードレビューにラベルを付けるだけでチームの心理的安全性を高めた話
コードレビューのイロハをまとめました（レビュイー/レビュアー両者の心得や実践的なテクニックなど） #コードリーディング - Qiita
検証まとめ
説明することは当然だったが、ラベルをつけることによって、メタ情報が加わり、説明内容が伝わりやすくなるよというのが多くのサイトで見られた。
ラベル付によるメリットは、調査した感じだと以下の通り。
ラベルを付けることのメリット
- 認識の齟齬が起こらない
- 優先順位の明確化
- コメントの敷居が下がることより、議論の活性化
- レビューイの判断がやりやすくなる
感想＋雑記
レビューをする側になって、なかなか意図が伝わらないってことはよく感じる。
相手が悪いかというと、そうでもなく、自分の伝え方が悪いってこともあるとは思っているけど、何が悪いのかってケース・バイ・ケースで分かりづらいんだよね。
伝える創意工夫は、決まったパターンを使うのは、アリだとは思う。
特に、検証で調べた際のタグ情報の付与は、たしかになと思った。
メタ情報が理解を促進させるというのは、プログラミングしてても感じるので、タグを付けて意図を明確化するという話は、結構すんなり理解はできた。
