コード検査ツールで組み込み開発の品質を高める
CodeDirectorを用いた問題解決
先述した、組み込み開発の現場で発生しがちな5つの問題点を、CodeDirectorを用いることで解決できます。
- 余裕が無い、人と時間
-
CodeDirectorは、サーバー側で一括してチェックを行う、サーバー集中型のツールです。開発者のPC上で実行するツールの場合は、開発者全員が環境を用意しなければならないほか、コード・チェックの実行待ちで開発時間も減ってしまいます。これに対し、サーバー側で一括して実施すれば、開発者のPCにインストールする必要がなく、時間の節約にもなります。
構成管理ツールと連携し、自動的に最新のソース・コードを取得します。構成管理ツールを使用しているプロジェクトであれば、開発者の作業は、結果レポートを確認して問題がある場合に修正を行うことだけです。
結果のレポートは、指摘内容と該当個所のソース・コードが記されたHTMLです。開発者は、問題の一覧をクリックするだけで、該当するコードをチェックできます。参照が容易であるうえ、特別なビューアが不要です。ソース単位でグループ化することもできます。
- 質の悪いソース・コード
-
エンハンスのベースになるソース・コードとの差分に限ってチェックすることが可能です。悪いところすべてを修正するのは、コスト的にもスケジュール的にも現実的ではありません。変更がない、すでに動作実績のある既存のプログラムについては指摘せず、新規に作成したか変更した部分に限ってチェックすることで、重要な指摘が埋もれないようにできます。
- 読みにくいソース・コード
-
コーディング・スタイルをチェックできます。保守性が悪い、可読性が低い、といったソース・コードを指摘できます。読みにくいソース・コードは保守性が悪く、不具合の原因になります。ルールに従ったきれいなソース・コードは、不具合そのものも少なく、保守性も良くなります。ソース・コードの寿命も延び、最終的なコスト削減につながります。
- 難しいコーディング・ルール
-
結果のレポートには、チェックに関する詳しい解説が付いています。解説を読むだけで、なぜ指摘されたのか、どのように対応すればよいのかが分かります。このため、コーディング・ルールに従った書き方を一度に覚える必要がなくなります。日々の開発の中で、指摘を受けながら、徐々に覚えていくことができます。担当者のスキル・アップにもつながります。
- 後回しにされる異常系テスト
-
テストと異なり、静的コード・チェックでは、すべてのソース・コードを一斉にチェックします。正常系や異常系の違いは関係ありません。また、サーバー側で一括チェックすることは、対象を漏れなくチェックできることを意味します。
図2: 結果レポートの例(クリックで拡大) |
CodeDirectorでチェックできること
具体的には、どのような不具合をチェックできるのでしょうか。チェックできる対象は、大きく分けて2つあります。1つは、製品の信頼性に関係する不具合です。システムが停止する、セキュリティ上の懸念が発生する、といった問題に対する項目です。もう1つは、保守性や移植性に関連する不具合です。コードの記述がルールどおりに記述されているか、不具合を作り込み易い記述になっていないかなど、コーディング・スタイルのチェックを行います。
不具合を検出できる例として、配列領域外アクセスの検出があります。以下の例を見てください。
ここでは、バッファに初期値を設定しています。一見したところ、問題がなさそうに見えます。しかし、これでは、メモリーを壊してしまいます。init[]は文字列定数なので、\0終端が隠れています。このため、10バイトの領域に11バイトを書き込んでしまうのです。この例では問題を単純化していますが、実際に使われる時は、もっと分かりにくく、発見も難しくなっていることでしょう。