...
| Code Block |
|---|
// parasoft-suppress <rule-id>|<rule-category>|ALL "<suppression comment>" |
例:
| Code Block |
|---|
// parasoft-suppress CODSTA "suppress all rules in category CODSTA"
// parasoft-suppress CODSTA.NEA "suppress rule CODSTA.NEA"
// parasoft-suppress CODSTA-1 "suppress all rules in category CODSTA with severity level 1"
// parasoft-suppress ALL "suppress all rules"
// parasoft-suppress CODSTA FORMAT.MCH JAVADOC-3 "suppress all rules in category CODSTA and rule FORMAT.MCH and all rules in category JAVADOC with severity level 3" |
ブロック単位の抑制
ブロック単位の抑制を使用すると、コード ブロックの違反を抑制できます。次の構文を使用して、違反があるコード ブロックの前後に開始/終了コメントを指定します。
| Code Block |
|---|
// parasoft-begin-suppress <rule-id>|<rule-category>|ALL "<suppression comment>"
... code block ...
// parasoft-end-suppress <rule-id>|<rule-category>|ALL "<suppression comment>" |
例:
| Code Block |
|---|
// parasoft-begin-suppress CODSTA "begin suppress all rules in category CODSTA" |
...
...
// parasoft-end-suppress CODSTA "end suppress all rules in category CODSTA"
// parasoft-begin-suppress CODSTA.NEA "begin suppress rule CODSTA.NEA" |
...
...
// parasoft-end-suppress CODSTA.NEA "end suppress rule CODSTA.NEA"
// parasoft-begin-suppress CODSTA-1 "begin suppress all rules in category CODSTA with severity level 1" |
...
...
// parasoft-end-suppress CODSTA-1 "end suppress all rules in category CODSTA with severity level 1"
//parasoft-begin-suppress ALL "begin suppress all rules" |
...
...
// parasoft-end-suppress ALL "end suppress all rules"
// parasoft-begin-suppress CODSTA FORMAT.MCH "begin suppress all rules in category CODSTA and rule FORMAT.MCH" |
...
...
// parasoft-end-suppress CODSTA FORMAT.MCH "end suppress all rules in category CODSTA and rule FORMAT.MCH"
// parasoft-begin-suppress CODSTA "begin suppress all rules in category CODSTA" |
...
...
// parasoft-end-suppress CODSTA-1 "end suppress all rules in category CODSTA with severity level 1; however rules with severity level 2-5 in category CODSTA are still suppressed." |
...
...
// parasoft-end-suppress CODSTA "end suppress all rules in category CODSTA"
// parasoft-begin-suppress ALL "begin suppress all rules" |
...
...
// parasoft-end-suppress CODSTA FORMAT-1 "end suppress all rules in category CODSTA and all rules in category FORMAT with severity level 1; however, others rules in CODSTA and FORMAT-1 are still suppressed." |
...
...
// parasoft-end-suppress ALL "end suppress all rules"
//parasoft-begin-suppress ALL "begin suppress all rules, since no end suppression comment, all rules will be suppressed starting from this line" |
| Anchor |
|---|
| In-file Suppressions Format |
|---|
| In-file Suppressions Format |
|---|
|
抑制ファイルでの抑制の定義
...
次のフォーマットを使用して parasoft.suppress ファイルに抑制エントリを追加します。
| Code Block |
|---|
suppression-begin |
...
file: Account.java (required) |
...
...
rule-id: CODSTA-123 (optional) |
...
message: Exact violation message (optional) |
...
reason: Approved (optional) |
...
...
date: 2020-09-21 (optional) |
...
例:
最低でも、問題が検出されたソース ファイルを指定する必要があります。ソース ファイルだけを指定すると、指定されたファイルに対してレポートされたすべての指摘事項が抑制されます。次のサンプルでは、Account ファイルで検出されたすべての違反が抑制されます。
| Code Block |
|---|
suppression-begin |
...
...
他の属性は任意であり、抑制を細かく制御するのに利用できます。次のサンプルでは、Account ファイルで検出された PB.TYPO.TLS ルールのすべての違反が、違反が発生した行にかかわらず抑制されます。
| Code Block |
|---|
suppression-begin |
...
...
...
属性に関する注意点
- 抑制の理由を記述するのは良いプラクティスです。
line 属性の使用には注意が必要です。ソース ファイルが変更され、コードが別の行に移動すると、抑制が無効になる可能性があります。
...