カスタムメトリックに基づいたワーニングクラス

JavaScript is not currently enabled, but is required for full CodeSonar manual search and browse functionality.

If you are viewing this file in your hub's Web GUI, enable JavaScript in your browser: you will also need it for GUI functionality.

If you opened this file directly from disk, your browser may be directly suppressing JavaScript functionality: certain browsers perform this suppression on local files (but not files delivered by web servers) for security reasons.

If you access the manual through the hub's Web GUI, the functionality will not be suppressed because the hub is a web server.
Alternatively, your browser may allow you to explicitly disable the security setting that suppresses functionality. See the CodeSonar FAQ for more information.

CodeSonar はメトリックの値に基づいたカスタムワーニングクラスの設定をユーザに許可する設定パラメータを提供します。カスタムメトリックワーニングクラスは以下の４つの設定により定義されます。

METRIC_WARNING_CLASS_NAME

ワーニングクラス名を設定します。

METRIC_WARNING_CONDITION

metric_tag[metric_granularity] op num の条件式で設定します。（op は <, <=, >, >= のいずれか）

設定された範囲にメトリックの値が入った場合に、ワーニングが発生します。

METRIC_WARNING_SIGNIFICANCE

ワーニングクラスのクラス分類を設定します。

METRIC_WARNING_CATEGORIES
[optional]

ワーニングクラスのカテゴリを設定します。

METRIC_WARNING_BASE_RANK
[optional]

ワーニングクラスのランク値を設定します。

general template configuration file のコメント中に METRIC_WARNING_* ルール実装の３つの例を含んでいます。それらのクラスのチェックを有効にする場合は以下の様にしてください。

（頭の '#' を取り除き）クラスのルールを有効にします。

METRIC_WARNING_CONDITION ルールで使用しているメトリックが METRIC_FILTER にて有効であることを確認します。

必要があれば METRIC_WARNING_CONDITION ルール内で定義される定数の境界を調整します。

このクラスが有効な場合、サイクロマティック複雑度が 20 以上の複雑な関数で High Cyclomatic Complexity （高いサイクロマティック複雑度）ワーニングを検出します。

#     METRIC_WARNING_CONDITION = vG[PROCEDURE] >= 20$
#     METRIC_WARNING_CLASS_NAME = High Cyclomatic Complexity
#     METRIC_WARNING_CATEGORIES = METRIC.VG
#     METRIC_WARNING_BASE_RANK = 5.0
#     METRIC_WARNING_SIGNIFICANCE = STYLE

このクラスが有効な場合、 100 行以上の関数で Large procedure（大きな関数）ワーニングを検出します。

#     METRIC_WARNING_CONDITION = LCode[PROCEDURE] > 100$
#     METRIC_WARNING_CLASS_NAME = Large procedure
#     METRIC_WARNING_CATEGORIES = METRIC.LCODE
#     METRIC_WARNING_BASE_RANK = 1.0
#     METRIC_WARNING_SIGNIFICANCE = STYLE

このクラスが有効な場合、 CodeSonar は 5 行以下のコメントを含む関数で、 Too few comments （少なすぎるコメント）ワーニングを引き起こします。

#     METRIC_WARNING_CONDITION = LCom[PROCEDURE] < 5$
#     METRIC_WARNING_CLASS_NAME = Too few comments
#     METRIC_WARNING_CATEGORIES = METRIC.LCOM
#     METRIC_WARNING_BASE_RANK = 2.0
#     METRIC_WARNING_SIGNIFICANCE = STYLE

設定ファイルの以下のパラメータがこのワーニングクラスのチェックに影響します。

カスタムメトリックに基づいたワーニングクラス

例

高いサイクロマティック複雑度 (High Cyclomatic Complexity)

大きな関数 (Large procedure)

少なすぎるコメント Too few comments

関連のある設定ファイルパラメータ