ガイドラインをチェック (-guidelines)

ガイドラインに対する違反のチェック

R2021a 以降

説明

このオプションは Bug Finder のみに影響します。

ガイドラインに対する違反をチェックするかどうかを指定します。各オプション値はチェックすべきガイドラインのサブセットに対応します。

オプションの設定

以下のいずれかの方法を使用してオプションを設定します。

このオプションを使用する理由

ガイドラインは、コーディングのベスト プラクティスに対する違反をチェックするカスタマイズ可能なチェッカーです。このオプションを使用して、要件に合ったガイドライン ルールのサブセットを指定できます。

解析後、[結果のリスト] ペインに違反がリストされます。[ソース] ペインでは、Polyspace はすべての違反に対し、 シンボルを関連するキーワードまたは識別子に割り当てます。

設定

all

既定のしきい値を使用するすべてのガイドライン ルールに対する違反をチェックします。

ガイドラインを参照してください。

his

Hersteller Initiative Software (HIS) 標準で規定されたソフトウェア複雑度メトリクス標準に対する違反をチェックします。HIS コード複雑度メトリクスを参照してください。

HIS 標準では、ソフトウェア複雑度チェッカーのサブセットに対して特定のしきい値を推奨しています。入力 [his] を使用すると、Polyspace はこのソフトウェア複雑度チェッカーのサブセットをアクティブにし、HIS 推奨しきい値を使用します。ソフトウェア複雑度メトリクスが HIS 推奨しきい値を超えた場合、Polyspace は違反を報告します。

from-file

特定のしきい値のガイドライン チェッカーのカスタム選択が構成された XML ファイルを指定します。Polyspace デスクトップで解析を実行する場合、デスクトップ ユーザー インターフェイスを使用して、チェッカー構成を含む XML ファイルを作成または編集します。Polyspace Server で解析を実行する場合、既存のチェッカー選択ファイルを編集します。Polyspace as You Code で解析を実行する場合、[チェッカーの選択] ユーザー インターフェイスを使用して、チェッカー構成を含む XML ファイルを作成または編集します。

値 [from-file] を使用するときには、オプション [ファイルごとにチェッカーを設定] (-checkers-selection-file) を使用してチェッカー選択 XML ファイルを指定します。

ヒント

  • オプション ファイルを使用するときには、ガイドライン チェッカーを有効にし、チェッカー選択ファイルを指定してしきい値を変更できます。たとえば、オプション ファイルで次のように入力します。 

    -guidelines from-file
-checkers-selection-file selection_xml
    コマンド ラインで上記のオプションを一緒に使用することもできます。

  • あるいは、コマンド -checkers-activation-file を使用してチェッカー アクティベーション ファイルを指定することもできます。欠陥とコーディング規約に対する具体的なオプションを指定する必要はありません。たとえば、コマンド ラインまたはオプション ファイルで次のように入力します。 

    -checkers-activation-file activation_xml
    ここで、ファイル activation_xml は、[チェッカーの選択] ユーザー インターフェイスを使用して作成したチェッカー アクティベーション ファイルです。ファイル activation_xml でガイドライン チェッカーをアクティブにした場合、オプション -guidelines を指定する必要はありません。

  • このオプションは、Polyspace によるコード メトリクスの計算方法を変更します。

    これらのオプションにより、コード内のガイドライン違反の数が変化する場合があります。

コマンド ライン情報

コマンド ラインでコマンド -guidelines を使用して、コード複雑度ガイドラインの違反をチェックします。

パラメーター: -guidelines
値: all | his | from-file
例 (Bug Finder): polyspace-bug-finder -sources file_name -guidelines his
例 (Bug Finder Server): polyspace-bug-finder-server -sources file_name -guidelines from-file -checkers-selection-file path_to_xml

または、チェッカー アクティベーション XML ファイルを使用して、すべてのまたは特定のコード複雑度ガイドラインを有効にします。チェッカー アクティベーション ファイル (-checkers-activation-file) を参照してください。

バージョン履歴

R2021a で導入

参考

トピック