🔍

ソースレビューでレビューで最低限気をつけている事

2022/06/29に公開

ソースレビューで最低限気をつけていること

  • 設計書に沿った実装になっていること
  • 変数名、関数名が分かりやすいこと
  • [Kotlinの場合]名前付き引数を使用していること
  • ネストが深くなっていないこと、早期リターンを使っていること
  • 正確なテストケースが書かれていること
  • 各パッケージやクラスの責務にあった実装がされていること
  • トランザクションが正しい場所で設定されていること
    • DBにリードレプリカがある場合、読み込み専用処理にはリードオンリーにすること
  • リクエストパラメータにValidationをつけていること
    • @NotNull、@Min、@Max、@Pattern等
    • アノテーションで対応できない場合は独自Validatorでチェックしていること
  • できる限り変数は不変かつNotNullにすること
  • try-catchで囲むのは、例外が発生する可能性があるソースになっていること。無駄にソースを囲っていないこと
  • リソースをcloseする必要がある処理は、try-with-resource(or use)を使っていること
  • エラーログのメッセージ内容がわかりやすいこと。具体的には、どこで・どんな理由でエラーが発生しているかわかること

Discussion