JSF AV C++ ルールのチェック (`-jsf-coding-rules`)

JSF C++ ルールに対する違反のチェック

説明

JSF^® AV C++ ルール (JSF++:2005) に対する違反をチェックするかどうかを指定します¹ .オプションのそれぞれの値はチェックするルールのサブセットに対応します。

オプションの設定

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

Polyspace^® ユーザーインターフェイス (デスクトップ製品のみ): プロジェクト構成で [コーディング規約およびコードメトリクス] ノードを選択してから、このオプションの値を選択します。最初に有効にしなければならない他のオプションについては、依存関係を参照してください。
Polyspace Platform ユーザーインターフェイス (デスクトップ製品のみ): このオプションは、プロジェクト構成には存在していません。チェッカーを有効にするには、オプション [カスタムチェッカーファイルを使用] と [チェッカーアクティベーションファイル] (-checkers-activation-file) を使用します。
コマンドラインとオプションファイル: オプション -jsf-coding-rules を使用します。コマンドライン情報を参照してください。

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

このオプションを使用して、チェックする JSF:C++ ルールのサブセットを指定します。

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

設定

既定値: shall-rules

shall-rules

すべての Shall (必須) ルールをチェックします。Shall (必須) ルールは必須要件であり検証が必要です。

shall-will-rules

すべての Shall (必須) および Will (必要) ルールをチェックします。Will (必要) ルールは必須要件とされますが、検証を必要としません。

all-rules

すべての Shall (必須)、Will (必要) および Should (勧告) ルールをチェックします。Should (勧告) ルールは、勧告ルールです。

from-file

このコーディング規約のチェッカーのカスタム選択が設定されている XML ファイルを指定します。構成ファイルを作成するには、をクリックして、[チェッカーの選択] ウィンドウの右側のペインから、このコーディング規約に対してチェックするルールと推奨事項を選択します。ファイルを保存します。

既存の構成ファイルを使用または更新するには、[チェッカーの選択] ウィンドウで所定のフィールドにファイルへの絶対パスを入力するか、[参照] をクリックします。

オプションを [from-file] に設定する場合、[ファイルごとにチェッカーを設定] (-checkers-selection-file) を有効にします。

ヒント

プロジェクトで [コンパイラ] (-compiler) に [generic] 以外の設定を使用する場合、一部のルールのチェックは不完全になる可能性があります。たとえば、次の AV ルール 8 です。"すべてのコードは ISO/IEC 14882:2002(E) 標準 C++ に準拠する"

依存関係

このオプションは、[ソースコードの言語] (-lang) が [CPP] または [C-CPP] に設定されている場合にのみ使用できます。

プロジェクトで C コードと C++ コードとが混在する場合、JSF C++ チェッカーが解析するのは .cpp ファイルのみです。

コマンドライン情報

コマンドラインでコマンド -jsf-coding-rules を使用して、JSF C++ ルールの違反をチェックします。

パラメーター: -jsf-coding-rules

値: shall-rules | shall-will-rules | all-rules | from-file

例 (Bug Finder): polyspace-bug-finder -sources file_name -jsf-coding-rules all-rules

例 (Bug Finder Server): polyspace-bug-finder-server -sources file_name -jsf-coding-rules all-rules

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

バージョン履歴

すべて展開する

R2021b: テキスト形式を使用したコーディングルールファイルのサポートは終了します

R2019a 以降、コーディング規約チェッカーのカスタム選択を定義するファイルでは XML 形式を使用します。この目的でのテキストファイルの使用はエラーになります。Polyspace でサポートされるすべてのコーディング規約のカスタム選択を同じファイルに保存できます。

デスクトップインターフェイス:

テキスト形式のカスタムコーディング規約選択ファイルを含むプロジェクトがある場合、Polyspace はそれらのファイルを自動的に更新して単一の XML ファイルに統合します。同じカスタム選択ファイルを参照する競合する構成がプロジェクトにある場合、各構成の統合されたコーディング規約選択が個別の XML ファイルに保存されます。

テキストファイルを XML 形式に手動で更新するには、[構成] ペインの [コーディング規約およびコードメトリクス] ノードでをクリックします。[チェッカーの選択] ウィンドウで、ファイルを選択して [変更の保存] をクリックします。Polyspace によってファイルが単一の XML ファイルに統合され、このファイルが filename.xml として保存されます。ここで、filename は、選択したファイルの名前のうちアルファベット順で最初の名前です。たとえば、foo.conf と bar.conf を選択した場合、bar.conf.xml として保存されます。

コマンドライン/ IDE:

コマンドラインまたは IDE 拡張機能では、-jsf-coding-rules への入力としてテキストファイルを使用するとエラーになります。JSF C++ ルールのカスタム選択を選択するには、XML ファイルを使用します。

ファイル jsf_av_cpp.xml をテンプレートとして使用し、コーディング規約チェッカーのカスタム選択を定義する XML ファイルを作成します。このテンプレートファイルは polyspaceroot\polyspace\examples\doc_cxx\coding_standards_XML にあります。ここで、polyspaceserverroot は Polyspace 製品のルートインストールフォルダーです。たとえば、C:\Program Files\Polyspace\R2025b です。スクリプトを更新する場合は、次の表を参照してください。

オプション	代わりに使用
`-jsf-coding-rules "custom_standard.conf"`	`-checkers-selection-file "custom_standard.conf.xml" -jsf-coding-rules from-file`

詳細は、以下を参照してください。

XML 形式の構成ファイルの例

R2019b: テキスト形式を使用したコーディングルールファイルのサポートは終了します

R2019a 以降、コーディング規約チェッカーのカスタム選択を定義するファイルでは XML 形式を使用します。Polyspace でサポートされるすべてのコーディング規約のカスタム選択を同じファイルに保存できます。テキストファイルを使用すると、Polyspace が警告を出し、テキストファイルが XML に変換されます。

参考

次に対する結果を生成しない (-do-not-generate-results-for)

トピック

¹ JSF and Joint Strike Fighter^® are registered trademarks of Lockheed Martin^®.

JSF AV C++ ルールのチェック (-jsf-coding-rules)

説明