LoginSignup
1
1

コードレビューしましょう

Posted at

チェックリスト

  • 見た目の美しさ
    • インデントやタブ、改行が適切か
    • デザイン通りか、違和感がないか
    • コーディング規約に準拠しているか
    • 不要なコードが残ってないか
  • 動き
    • 仕様通りか
    • 負荷が大きくないか
    • N+1などあるか
    • 別の影響されるところがあるか
    • 動作問題ないか
    • ロジックが正しいか
    • 新しいバグが追加されていないか
    • テスト環境に確認必要か
  • 可読性
    • 名付けは適切か、
      • 関数名は機能を明確に表したものになっているか
      • 変数名から内容が予測できる名称になっているか
      • 長さは適切か
    • 処理や制御がわかりやすくになっているか、
    • ネストしすぎていないか
      • 階層最大3になるか
    • コメントは明確か
      • 簡潔なコメントか
      • 必要に応じて参照のリンクがあるか
      • FIXMEやTODOなど場合、ちゃんと明確にされているか
        • 例:TODO:内容、タスクリンク、作成者名前
    • コードの構造が明確であるか
      • 不要なループはないか
      • 適切な例外処理が入っているか
  • 拡張性・保守性
    • DRYを意識できているか
      • 共通化できているか
      • より良い方法にリファクタリングできているか
      • 関数化ができているか、
    • セキュリティ面での欠陥がないか

意識ポイント

  • わからない場合は質問する
  • いいコードと思う場合褒める
  • コメントに[must][imo][nits][ask]などの先頭付けて、コミュニケーション効率化にする
  • 根拠を示す
  • フレンドリーで具体的
  • あまり小さなことにこだわらない
  • 改善すべき点がある場合言う
1
1
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
1
1