カテゴリ:Tech投稿日:
自分のコードレビュー観点を書き出してみるのサムネイル

自分のコードレビュー観点を書き出してみる

はじめに

自分用のチェックリストとして、レビュー時の観点をまとめてみた。
殴り書きで漏れがありそうなので、随時更新してブラッシュアップしていきたい。
動作するか、仕様を満たすか、シンプルかを重視してみているような気がしている。

レビュー時の観点

  • 動作するか
    • エラーが起きていないか
      • CI でチェックされる想定
    • 無限ループが起きていないか
    • build できるか
      • CI でチェックされる想定
    • レスポンシブ対応
      • ローカルのスマホ実機でみれるか
  • 仕様を満たしているか
    • デザインの要件通りか
      • 改善できる点があればデザインへフィードバックできるか
    • サーバーの要件通りか
      • 改善点あればフィードバックできるか
  • よりシンプルなコードにできないか
    • ひとつの関数で複数の役割を担ってしまっているか
    • コンポーネントを分割し、小さくできるか
    • early return を使えるか
      • ネストした if 文を解消できないか
    • if else を連なっているなら switch を使えるか
    • テストしやすいか
  • 車輪の再発明をしていないか
    • ネイティブの API やライブラリで実現可能など
    • すでに開発済みのコードを再利用できないか
  • マジックナンバーはないか
  • HTML の構造が合理的かどうか
  • 命名がコードに即した内容か
  • セキュリティの観点で懸念はないか
    • サニタイズしていないなど
  • アクセシビリティの観点で懸念はないか
    • img の alt がないなど
  • コードコメントが必要か
    • TODO や MEMO など
    • /* */ を使う。補完するときに出てくる
    • workaround

関連する投稿があります

ブログ運営者
muuuuminn
経歴:
SE:1年半 → FE:5年 → ?
スキル:
Next.js, TypeScript, React, Notion
趣味:
ゲーム, 手品, 開発, コレクション, 映画