悪い習慣１ コードの可読性・拡張性を考慮してコーディングしていない |
を防止するために、バグ作り込みの防止や、ソースファイルの可読性向上を目的とした「コーディング規約」が存在します。
その中でも、ソフトウェア開発現場で利用されている「コーディング規約」で解析を行ってみましょう。
コーディングルール自動チェックとは
ここで利用するC++test機能は、コーディングルールチェック機能になります。コーディングルールチェック機能は、4200種類以上のルールを搭載
しており、C/C++両言語を解析します。
右の図に記載されている一部のルールカテゴリは、コンプライアンスパック（別売り）のライセンスをアクティベートする必要があります。
|
|
解析実行手順
|
|
|
|
解析結果の見方
解析結果は、[品質タスク]ビューに表示され、下図に示す３つのポイントで確認します。
コーディングルール自動チェック機能 運用ワンポイント アドバイス
これまでコーディング規約を適用しなかったソースコードでチェックを行うと、多くの違反が見つかるでしょう。
全て直さなくてはいけないと考えると途方にくれると思います。しかし、最初から全てを直すことを目的としてはいけません。
違反の修正を考える前に確認することがあります。
それは、今の開発現場の方々がどういう習慣や癖を持ってコーディングしているかを確認します。
確認ポイント１ |
違反が検出されたルールの内、違反件数が多いルールと少ないルールに分けます。 |
確認ポイント２ |
違反件数が少ないルールは、「開発現場の方が守ろうとして守りきれなかったルール」の可能性が高いと予測されます。 |
確認ポイント３ |
違反件数が多いルールは、「開発現場の方が守ろうと考えていなかったルール」です。その中で、過去のバグを防止できるコーディングルールが無いかを確認します。 |
コーディングルールチェック機能を開発現場で利用する初期段階では
- 違反件数の少ないルール
- 違反件数が多いが過去のバグを防止できるルール
を、今後の新規追加コードに対し適用を徹底化し、開発現場の悪い習慣を防止します。
ルールセットを変更したい場合
一回目のコーディングルールチェック結果から、今の開発現場の方がどういう習慣や癖を持ってコーディングしているかを確認したら、開発現場に適した解析をするルールセットをチューニングする必要があります。
C++testでは全ての静的解析ルールを取捨選択可能です。
ここでは、2_コーディング規約チェック（チュートリアル）ルールセットの中から、「暗黙的にキャストしているコードを禁止する」ルールを抜き出して、別途ルールセットを作成する方法をご紹介します。
|
|
|
|
|
|
|
|
|
|
|
|
|
|
開発現場の方々がコーディングルールを全て暗記できないことに備えて
C++testに搭載されている静的解析用の各ルールにはルールの説明ヘルプ画面が搭載されています。
静的解析での違反結果のレビュー時に、説明ヘルプ画面を表示することが可能であるため、開発現場の方々は都度ルールの内容を暗記する必要はありません。
|
|
|
|
正当なレビュー結果から次回違反として検出しないために
C++testの静的解析で検出された違反は、レビュー後、次回違反として検出されないように「抑制」を設定することができます。
|
|
|
|
|
- [抑制された理由]画面が表示されたら、[理由]を入力します。
- [OK]を選択します。|
