EN JP CN

checkers.xml:C/C++ チェッカーの設定カテゴリ、重要度、およびエラーメッセージの定義

checkers.xml:C/C++ チェッカーの設定カテゴリ、重要度、およびエラーメッセージの定義

kwcreatechecker を実行すると、--code オプションで指定した <CHECKER.CODE> ディレクトリに checkers.xml ファイルが作成されます。

次のテーブルは、checkers.xml ファイル内の要素に関する詳細を示します。

要素 デフォルト値 変更しましたか?(はい/いいえ) 説明
<checkers version>1.3いいえこのバージョンは、現在の Klocwork チェッカーバージョンが使用されていることを反映しています。値は 1.3 です。 変更しないでください。
<categories>該当せずいいえ指摘の分類方法を示します。最高レベルのカテゴリは言語です。下の <category name> を参照してください。
<category name>Javaはいチェッカーは Java チェッカーであることを示します。この値は変更することができますが、この要素を削除してカスタムチェッカーを別の方法で分類することもできます。サーバープロジェクトまたはデスクトッププロジェクトの場合、指摘カテゴリは Configuration Editor に表示されます。Configuration Editor では、指摘の解析をオンまたはオフにします。統合ビルド解析用チェッカーの設定を参照してください。
<category name>カスタムチェッカーはいチェッカーを "カスタムチェッカー" 以外のカテゴリにする場合は、カテゴリ名を変更します。カテゴリ名の詳細については、上述の <category name> を参照してください。
<error id><CHECKER.CODE>いいえkwcreatechecker--code オプションで指定した指摘コードを反映します。チェッカーの名前を変更する場合は、チェッカーファイルを再度作成し、新しい名前を指定してください。その後、関連するデータを新しいファイルにコピーします。 パスチェッカーの名前を編集しないを参照してください。
<checkergroup language>Javaいいえチェッカーは Java プログラム用であることを示します。
<api>パスいいえkwcreatechecker--type <common or kast> オプションで指定したチェッカータイプを反映します。Common はパスのことです。KAST タイプはツリーパターンとして表示されます。
<checkerclass>"説明" の欄を参照してください。いいえ自動入力される値は次のとおりです。
  • com.klocwork.jdefects.checkers.dfa.sourcesink.SVChecker
  • com.klocwork.jdefects.checkers.dfa.sourcesink.RLKChecker
  • com.klocwork.jdefects.checkers.dfa.sourcesink.SourceSinkChecker 注意:SourceSinkChecker 値は、共通パスチェッカーを示します。
<error id><CHECKER.CODE>いいえこの ID は、チェッカーによって指摘が検出された場合に解析結果に表示されます。
<message>"Your message goes here "はいこのチェッカーによって指摘が検出された場合に解析結果に表示するメッセージを (関連するパラメーターとともに) 指定します。たとえば、"JNDI data {0} leak " などです。可能性のあるパラメーター値は次のとおりです。
  • {0} シンクの説明
  • {1} ソースの説明
  • {2} シンク式のソースコード ({0} と同じ場合もあります)
  • {3} ソース式のソースコード ({1} と同じ場合もあります)
<title>"Your title goes here"はいチェッカータイトルは Configuration Editor に表示されます。たとえば、"JNDI information leak" などです。
<severity>4はい指摘重要度を参照してください。
<enabled>trueはい新しいチェッカーはデフォルトで有効になっていますが、値を false に変更することで無効にすることができます。Configuration Editor (Klocwork サーバープロジェクトおよびデスクトッププロジェクト) では、プロジェクトの複数のチェッカーを簡単に有効化または無効化できます。
<parameter name = "kbsection" value="CHECKER.CODE>.jkb>kbsectionいいえパラメーター名と値は、チェッカーを特定の knowledge base (ナレッジベース) ファイルにバインドします。値は、knowledge base (ナレッジベース) ファイルの名前を反映します。