C/C++ 変数および関数の命名規則の強制

この例では、C/C++ コードでの関数とオブジェクトの命名規則違反を確認する方法を示します。命名規則ごとに、正規表現の形式でパターンを指定します。ソフトウェアでは、このパターンをソースコードの識別子と比較して、識別子が命名規則に従っているかどうかを確認します。

チュートリアルでは、ファイル printInitialValue.c 内に保存された次のコードを使用します。

#include <stdio.h>

typedef struct {
    int a;
    int b;
} collection;

void main()
{
    collection myCollection= {0,0};
    printf("Initial values in the collection are %d and %d.",myCollection.a,myCollection.b);
}

命名規則の指定

カスタムコーディングルールチェッカーは、コードの識別子を指定された命名規則と比較します。Polyspace^® は、識別子が規則に一致していない場合に違反を報告します。カスタムコーディングルールを使用して命名規則を適用するには、その前に正規表現を使用して命名規則を指定します。

[チェッカーの選択] ウィンドウを開きます。このウィンドウを開くには、ワークフローに応じて、Polyspace as You Code IDE プラグイン、デスクトップユーザーインターフェイス、コマンド polyspace-checkers-selection のいずれかを使用します。
[チェッカーの選択] ウィンドウで、ルール 4.3 を選択します。
[規則] フィールドに、ルール違反があった場合に表示するメッセージを入力します。このメッセージには、指定する命名規則の説明を含めます。たとえば、[規則] フィールドに All struct fields must begin with s_ and have capital letters or digits と入力します。
[パターン] フィールドに、指定する命名規則に対応する正規表現を入力します。たとえば、s_ で始まり、大文字または数字が含まれている struct フィールド名を表すには、s_[A-Z0-9_]+ と指定します。Polyspace では、パターンの定義で Perl 正規表現がサポートされています。カスタムルールのチェック (-custom-rules) を参照してください。

[パターン] フィールドが空白の場合、カスタムルールは有効になりません。
[コメント] フィールドはオプションです。コメントは Polyspace の結果リストには表示されません。[コメント] フィールドを空白のままにします。
XML ファイルに変更を保存してウィンドウを閉じます。この XML ファイルを使用して、指定されるカスタムルールをチェックできます。

あるいは、既存のチェッカー XML ファイルを編集して命名規則を指定します。Polyspace インストールフォルダーに含まれているテンプレートをコピーして編集できます。

polyspaceroot\polyspace\examples\doc_cxx\coding_standards_XML でテンプレート custom_rules.xml を見つけます。ここで、polyspaceroot は Polyspace 製品のルートインストールフォルダーです。たとえば、C:\Program Files\Polyspace Server\R2025a です。custom_rules.xml ファイルの編集可能なコピーを作成します。
編集可能な XML ファイルで、ルール 4.3 に対応するノードを見つけます。state 属性を on に設定します。サブノード Convention を追加し、All struct fields must begin with s_ and have capital letters or digits として指定します。次にサブノード Pattern を追加し、s_[A-Z0-9_]+ として指定します。次に例を示します。
```
      <check id="4.3" state="on">
	  <convention>All struct fields must begin with s_ and have capital letters or digits</convention>
	  <pattern>s_[A-Z0-9_]+</pattern>
      </check>
```
XML ファイルを保存します。この XML ファイルを使用して、指定されるカスタムルールをチェックできます。

定義されているカスタムコーディングルールの違反の確認

命名規則を指定したら、Polyspace 解析を実行します。

Polyspace デスクトップ UI、または IDE の Polyspace as You Code プラグインの 1 つを使用している場合は、[チェッカーの選択] ウィンドウで変更を保存した後で、Polyspace 解析を実行します。
コマンドラインインターフェイスを使用している場合は、解析時に、オプション [カスタムルールのチェック] (-custom-rules) と同時に、変更した custom_rules.xml ファイルをオプション [ファイルごとにチェッカーを設定] (-checkers-selection-file) の引数として指定します。たとえば、Polyspace Bug Finder Server を使用してカスタムルールをチェックするには、次のように入力します。
```
polyspace-bug-finder-server -sources printInitialValue.c -custom-rules from-file -checkers-selection-file custom_rules.xml
```

Polyspace 解析により、2 つのフィールド (collection.a と collection.b) でカスタムルール 4.3 の 2 つの違反が報告されます。

この欠陥を解決するには、命名規則に準拠するようにフィールド名を変更します。たとえば、フィールドの名前をそれぞれ s_A と s_B に変更します。フィールドの名前を変更したら、Polyspace 解析をもう一度実行して、命名規則に違反していないことを確認します。

参考

カスタムルールのチェック (-custom-rules) | ファイルごとにチェッカーを設定 (-checkers-selection-file)

C/C++ 変数および関数の命名規則の強制

命名規則の指定

定義されているカスタム コーディング ルールの違反の確認

参考

トピック

定義されているカスタムコーディングルールの違反の確認