🖊️テーマ
皆さんがコードレビューで意識しているポイントを教えて下さい。
個人的に意識していることだけでなく、所属組織でのルールなどでもOKです！
👤運営メンバーの回答
運営メンバーSさんがコードレビューで重視しているポイントは「コメントの質と量」でした！
コメントが少なすぎると読み手が意図を理解しづらくなりコミュニケーションコストが増えてしまうと考えているそうです。逆にコメントが多すぎると、読み手の学習機会の妨げになったりコードを読む際のノイズになるため、適切な量のコメントを心がけているとのことです。
〜teratailトーク!とは？〜
詳細を公式ブログで公開しています。ぜひお読みください。
「teratailトーク!」スタート🎉 気軽に意見交換しよう！
回答2件
#1
総合スコア86160
投稿2025/02/04 01:58
編集2025/02/04 10:27運営メンバーSさんがコードレビューで重視しているポイントは「コメントの質と量」でした！
に関連して言うと、「処理の仕方に関するコメントが無くても意味が分かるか？」ですかね。
クラス・関数・メソッドの仕様を、（各言語の一般的な形で）冒頭コメントに書くルールにするのはもちろん良いのですが、処理部分のコメントについての話です。「コメント書いたら今後ずっと二重メンテ必須」なので。
例えば、「トリッキーなことをしてコードを短くして、その説明コメントを丁寧に書く」なら「多少長くても簡明なコードを書く」ほうが良いと思います。そこが速度のボトルネックで性能チューニング意図なら別ですが。
似た話で、「言語の演算子や標準的な関数・メソッドを知らない人でも読めるように」は馬鹿げていると思います。
言語をよく知らない人は、追い出すか、学んでもらうべき。
ただ、「処理の仕方に関するコメントが無くても意味が分かるか？」は難しいので、どこかで妥協か。
#2
総合スコア37
投稿2025/02/05 07:56
・同じような処理を作っていないか
・無駄にグローバル変数を使っていないか
あなたの回答
tips
プレビュー
バッドをするには、ログインかつ
こちらの条件を満たす必要があります。