レビュー前に指差し確認したい!ソースコードセルフチェックシート12項目
skill

レビュー前に指差し確認したい!
ソースコードセルフチェックシート12項目

2014.06.05

ent38_img01.jpg

エンジニアのみなさん、自信をもってレビューに臨んでいますかーっ?!

今回は、新人エンジニアからベテランエンジニアまで、幅広い世代のエンジニアがレビュー前に使いたくなる12項目のソースコードセルフチェックシートのご紹介。
並べてみると当たり前のことばかりですが、こうしたセルフチェックのルールは言語化することが大切。レビュー前に「なんとなく不安」、「自分では良いのか悪いのかわからない」という状態を脱出するには、効果バツグンです。
自信をもってレビューに臨みたい、という方は、机の前に貼り出して使ってみてくださいね。

なお。
以下のチェックシートは、『完全版』ではありません。使用言語や開発の環境によって、追加したい項目、省きたい項目は適宜、改変してください。(イワタテ

● ソースコードセルフチェックシート12項目 ●

仕様は漏れなく反映されているか。
仕様を満たすことがソースコードの第一目的。優先順位を間違っていないか改めて確認。
コーディング規約に従っているか。
必ずしも効率的ではないローカルルールも存在するが、規約を無視したソースコードの寄せ集めはそれ以上に効率的ではない。
変数がプロジェクトのルールに則って命名されているか。
命名規約に違反する箇所を黙認すると、後々の問題発生時に解決までの苦労を倍増させる。
外部から取り込むデータは入力検査をしたか。
期待する機能を果たしているかどうか、手っ取り早く確かめる手段である。細かな手間を惜しまない。
冗長なステップがないか。
翌朝見直すとまだまだ削れるところがある。いかに綺麗に書けたコードでも、極限まで省く潔さが日本の美の心。
シンプルなコードか。(もっとシンプルにできるのではないか)
評価されるコードとは、無駄がなく遠回りでないコードである。
新人が読んでも理解できるコードか。
上級者を気取ったオリジナリティの高いコードは、後にアンタッチャブルのガラパゴスとなる運命である。
コメント文は親切か。
コードを見て理解しろというのは傲慢である。後に続くコードが何を意味するのか、どんな意図でそう書いたのか、丁寧にコメントをつけておけば後任者の負担は大幅に軽減される。
その関数は終了するか。(分岐によって無限ループとならないか)
ありえない操作をするユーザーが、ありえない選択を繰り返し美しい関数を無限ループに導く。
例外処理は適切か。
例外は必ず発生する。必要がないと思っても、アサートはやっぱり必要である。
単純なスペルミスがないか。
見直さない人のコードは、常に良くない。英語のスペル間違いや似た名前の変数にも注意!
このソースコードは美しいか。
本人が美しいと思っていないソースコードは、レビューに出しちゃダメである。戦え。

上記12点は、レビューをしてくれる上司が注目するポイントとイコールのチェックポイント。他者から見た場合の改善点を指摘してもらう工程も大切ですが、自分で改善できる箇所は自分で直す、という習慣ももちろん大切です。
迷ったときに立ち返る基本として、ぜひこのチェックシートをお試しください。

原稿:イワタテ
西東京市でコピーライター事務所をやってるイワタテです。
好きな言葉は「愛娘」。趣味は愛娘の写真撮影。
よく書くジャンルは、人材系、ビジネス系、IT系、ライフハック系、不動産系、おもしろ系……全部ですね。
Facebookの友達申請、お待ちしています。
https://www.facebook.com/iwatate1978

この記事はどうでしたか?

おすすめの記事

キャリアを考える

BACK TO TOP ∧

FOLLOW