SYSTEM-2-7

クライテリア

コードレビューガイドラインが些細な記述上のルールにとどまり、品質特性(保守性や拡張性など)に資する項目が十分に書かれていない。

タイプ

ソースコードの明確さ

観点

アンチパターン

FAQ

Q.コードレビューガイドラインをメンテナンスしなければならないのはなぜですか?

長期間コードレビューガイドラインがメンテナンスされていないとアプリケーションの仕様変更や開発方針の変更が反映されていない可能性があります。ツール導入によってチェックが自動化されている項目や、新たに加わったルールや十分にルールが浸透してレビューする必要のなくなったポイントを整備しておくとガイドラインは有効に機能します。

Q.コードレビューにガイドラインは必要ですか?

コードレビューにより確認すべきベストプラクティスがまとめられたドキュメントがあると見落としを予防すると共に、レビュー者のスキルに大きく依存することなくコード品質のチェックができるようになります。

用語解説

コードレビューガイドライン

コードレビューガイドラインとはコードレビューの際のベストプラクティスやその企業固有の開発における文化や規則を元にドキュメントにまとめたものです。

参考資料

  • googleコードレビューガイドライン