ルールおよびルール・カテゴリー

ルールは、静的分析構成の最小ビルディング・ブロックです。 各分析構成は、結果を生成する条件を定義しリソースの品質を評価するための、さまざまなルール、またはルールのセットを適用します。 ルール・カテゴリーは、標準への準拠という特定の面に焦点を当てた、分析ルールまたはその他のカテゴリーのコレクションです。

ルールは、コード作成時に従う必要のある 1 つのアクションを記述した特定の文です。例えば、以下の文はコード・レビュー・ルールです。

ルールは分析構成の基礎となります。分析を実行するときには、リソースが特定のルール、またはルールのセットに従っているかどうかを検査してください。ルールをアプリケーションの設計標準により適合したものにする必要がある場合には、ルールを変更したり、ユーザー定義ルールを作成したりすることができます。例えば、上にリストしたルールは、設計原則カテゴリーに属します。 類似の機能またはコード構成に適用されるルールは、同じカテゴリーに属します。 レビューの目的に応じて、複数のカテゴリーの中からルールを適用することができます。

重大度レベル

ルールの作成者は、ルールと矛盾するリソースが標準からどの程度深刻に逸脱しているのかを指定するために、各ルールに重大度レベルを割り当てます。 各ルールには、次の表に示す重大度レベルのうちの 1 つが指定されます。

アイコン 重大度レベル 説明
緑のチェック・マーク・アイコン。 推奨 これは最も低い重大度レベルです。この結果が示す問題は深刻ではありませんが、すぐに修正することを考慮する必要があります。
茶色の感嘆符アイコン。 警告 この重大度レベルは、解決が必要な問題がリソースにある可能性が非常に高いことを示します。
紫色の十字アイコン。 重大 これは最も高い重大度レベルです。この結果は、指摘されている問題を解決する必要があることを示します。

「推奨」は最も低いレベルの重大度ですが、この重大度レベルの結果に対処することは大切です。 これらの結果がすぐに問題とはならないとしても、今後これらが原因となって問題が発生する可能性があります。これらの規則は、開発チームが従うべき一連のベスト・プラクティスと業界標準に基づいています。

ルール・カテゴリー

分析ドメインは、カテゴリーを含むツールのグループを実装する、分析フレームワークのコンポーネントです。さまざまなタイプの分析のためにさまざまなドメインを選択することができ、また、分析の要求に応じて、ルール・カテゴリーおよびルール・カテゴリー内の個々のルールを使用可能または使用不可にすることができます。

ルール・カテゴリーの例として、コード・レビューのためのパフォーマンス・カテゴリーがあります。 パフォーマンスはアプリケーションの全体的な品質の重要な側面であり、コード・レビューでテストする特性に含める必要があります。パフォーマンス・ルール・カテゴリーには、メモリー、プロファイル、および速度の 3 つのサブカテゴリーがあり、各サブカテゴリーには、このカテゴリーを選択して分析を実行するときにソース・コードに適用する、ルールのセットが含まれます。

関連タスク
コード・レビューの実行
コード・レビュー結果の表示
コード・レビュー結果へのクイック・フィックスの適用
コマンド行からのコード・レビューの実行
Ant タスクとしてのコード・レビューの実行
関連資料
コード・レビューのリファレンス
ルールのカテゴリーおよびサブカテゴリーのリファレンス
コマンド行コード・レビューのリファレンス

フィードバック