この記事をシェアする

ソースコードレビューで持つべき7つの観点

さぁ、コードレビューの時間ですよ!@HIROCASTERでございませう。

前回はコードレビューという貴重な機会と時間の価値を最大化させるためのポイントについて考えました。

今回は実際にレビューするソースコードについて、汎用的な観点について考えます。

スポンサーリンク

美しく明確であるべき

どんなコーディングスタイルを採用したとしても、全体として美しく明確かどうかをレビューしてください。

平易な表現か?

平易な言葉で優しく表現されているか?聞き慣れない、わからない表現になっていないか。

重複はないか?

繰り返し使われているようなコードがないか。

ベストプラクティスがどうか?

プログラミング言語やフレームワークにベストプラクティスがあるはずです。ベストプラクティスに基づいているかをチェックしてください。多くの言語には地雷になる書き方があります。コーディングルールでカバーできる部分もあります。

Ruby on Railsでは静的コード解析で、ベストプラクティスに基づいているかチェックできるgemがあります。

機能が無利益なオペレーションを要求していないか?

作成された機能が無利益なオペレーションを要求していないか考えましょう。

変更にかかるコスト

例えば、この機能を追加するのにテーブルのカラムを追加するから、サービスを停止するメンテナンスが必要だ。など、このコードにかかるコストを意識しましょう。また、将来的な修正コストも考慮すべきです。

シンプルか?

例え、美しいコードであってもシンプルでなければいけません。

シンプルさ、単純さ、を優先すべきです。

リーダブルコード ―より良いコードを書くためのシンプルで実践的なテクニック (Theory in practice)

リーダブルコード ―より良いコードを書くためのシンプルで実践的なテクニック (Theory in practice)

Dustin Boswell、Trevor Foucher、須藤 功平、角 征典

前回までの記事はこちら

スポンサーリンク

この記事をシェアする

著者をフォローする