このセクションでは、 Coding Standards ツールの作成とカスタマイズについて説明します。Coding Standards ツールは、カスタム ルールやビルトイン ルールからなるユーザー定義のセットにコードが従っているかどうかを検証します。
このセクションの内容:

Coding Standards とは

Coding Standards ツールは、ユーザーのコードがルールに従っているかを検証します。 ルールは、特定の言語の W3C ガイドラインを検証します。 Coding Standards ツールはチームの命名規則、プロジェクト固有の設計要件、カスタム XML タグの適切な使用を検証します。 

新しい Coding Standards インスタンスを作成するとき、任意の数または任意の組み合わせのカスタム ルール、ビルトイン ルールをチェックするように構成できます。カスタム ルールはアプリケーション固有の設計やコンテンツ要件の検証、カスタム コーディング スタンダードの推進、命名規則の推進、問題を通知するテキストの識別 (例外メッセージなど)、 XML データ問い合わせ、またはカスタム ファイル変換を行うことができます。

カスタム ルールは RuleWizard から作成します。ルールを作成するには自動作成機能を利用する方法と、グラフィカルに作成する方法があります。カスタム ルール作成の詳細については、 RuleWizard GUI から [Help] > [RuleWizard Documentation] を選択し、『RuleWizard ユーザーズ ガイド』を参照してください。

一般的に、ユーザーはカスタム ルールの論理グループをチェックするためにカスタム Coding Standards ツールを作成します。たとえばチームが、プロジェクト固有の設計ガイドラインをチェックするルール、チームの命名ガイドラインをチェックするルール、チームで最も起こりやすいコーディング エラーをチェックするルール、といった 3 種類のルールを実装したとします。この場合、3 個の別々の Coding Standards ツール (ルールの論理グループごとに 1 ツール) を作成できます。 

Coding Standards の構成

Coding Standards ツールはチェックするルールを指定して構成します。コンフィギュレーション パネルでは次の操作ができます。

  • 個々のルールやルールのグループを有効/無効にするには、オプションをオン/オフにします。
  • パラメータライズ ルールをカスタマイズするには、ルールを右クリックして [ルールの参照 / 変更] を選択します。パラメータライズ可能なルールには、特別なアイコン (ラジオボタンが付いた帽子のマーク) が表示されます。
  • ルールを検索するには、[検索] をクリックし、ダイアログを使ってルールを検索します。
  • 無効なルールを非表示にするには、[有効なルールのみ表示] をクリックします。後で再びすべてのルールを表示するには、[すべて表示] をクリックします。
  • ルールの説明を参照するには、ルールのノードを右クリックし、[ルール ドキュメントの参照] を選択します。
  • No labels