読者です 読者をやめる 読者になる 読者になる

雀巽の日記帳

雀巽が綴る日常の記録

コードの品質測定とかレビューとか

ITライフ

コードレビューで踏み込み過ぎになりがちなので、自戒の意味を込めて考えたことの要点だけまとめてみます。

そのコードの受入基準は何なのか、レビューでは何を見るべきなのかを明確にして、ザルなレビュー、やり過ぎなレビューを阻止したい。

方針

  • コードの品質は基本的にテストで測定する
    • テストに落とし込めないメタ情報はドキュメントを書く
    • テストが不要な機能は動作確認で行えば良い
  • リファクタリングは必要だと感じたタイミングで行う
    • 機能追加時にコードの臭いを嗅ぎとったら検討すべき

リファクタリングの原則

コードレビュー

  • 適切な範囲のレビューを心がける
    • インターフェース(外部へ提供する機能など)
    • オブジェクトの振る舞い(クラス、シーケンス、テストなど)
    • 実装自体(コードの臭い、可読性、プログラミングテクニックなど)

テストのレビュー

  • 必要な振る舞いが適切にテストされているか

レビューの読み物

適切な品質測定やレビューが何かは常に考えておく必要があると思う。

感想

もっともっとインプットもアウトプットも増やしていかないとダメですね。

精進します!