MISRA C:2012 Dir 4.4

Sections of code should not be "commented out"

説明

命令の定義

Sections of code should not be "commented out" ¹ .

根拠

/* */ で囲まれた C コメントは入れ子をサポートしていません。/* で始まるコメントは、*/ が後続の入れ子のコメントの末尾として意図されている場合でも先頭の */ で終わります。既にコメントアウトされているコードのセクションにコメントが含まれている場合は、コンパイルエラー (または少なくとも意図されたものより少ないコードのコメントアウト) になる可能性があります。

コードのコメントアウトはお勧めしません。コメントアウトされたコードは、コンパイルエラーにはならず、周囲のコードと非同期のままになる可能性があります。後で、そのコードのコメントを解除すると、予期せぬ問題が発生する可能性があります。

コメントは、コード自体では明らかでないコードの側面を説明するためにのみ使用してください。

Polyspace 実装

チェッカーは内部でヒューリスティックな方法を使用してコメントアウトされたコードを検出します。たとえば、#、;、{、} などの文字はコードを含む可能性があるコメントを示します。このようなコメントは他のメトリクスに対して評価されて、コメントになりすましたコードである可能性を判断します。たとえば、数個の単語が間に記号をはさまずに連続していれば、この可能性は減少します。

チェッカーは、コードを含んでいても次のコメントに対してはフラグを設定しません。

/**、/*!、///、または //! で始まる doxygen コメント。
同じ記号を 5 回を超えて繰り返しているコメント。たとえば、次の場合の = 記号。
```
/* =====================================
 * A comment
 * =====================================*/
```
ファイルの最初の行のコメント。
C スタイル (/* */) と C++ スタイル (//) が混在したコメント。
1 つ以上の @ 記号が含まれるコメント。コードを含む入れ子のコメントに @ 記号が配置されている場合、Polyspace^® はこれにフラグを設定します。次に例を示します。
```
int* q;
//@Error int foo(void);
//...
void bar(void){
	/*
	int*p =  (int*) malloc(int); // Error @allocation
	*/
}
```
上記のコードで、Polyspace はコメントアウトされた malloc 演算を含む 2 番目のコメントブロックにフラグを設定し、最初のコメントを無視します。

チェッカーは、このようなコメントがドキュメンテーション目的か、または事前に考慮されたうえで意図的に入力されたものと見なします。

トラブルシューティング

ルール違反を想定していてもその違反が表示されない場合、コーディング規約違反が想定どおりに表示されない理由の診断を参照します。

例

すべて展開する

コメントアウトされたコード

#include <stdlib.h>
/* =====================================
 * usage:print32_tInteger(); 
 * =====================================*/
int32_t getRandInt();
void print32_t(int32_t);

//Error@ int32_t val = getRandInt();
void print32_tInteger() {
    /* int32_t val = getRandInt(); //Noncompliant
     * val++;  // contact support @..
     * print32_t(val); */     
    print32_t(getRandInt());
}

この例には、コードを含む複数のコメントが含まれています。

最初のコメントブロックでは、関数 print32_tInteger() の使用についてドキュメント化しています。このコメントでは = 記号を 5 回を超えて使用しているため、Polyspace はこのコメントにフラグを設定しません。
2 番目のコメントでは、コード内のエラーのソースについてドキュメント化しています。コードには @ 記号が含まれるため、Polyspace はこのコメントを無視します。
3 番目のコメントブロックでは、エラーが含まれる可能性のあるコードをコメントアウトしています。このコメントは何もドキュメント化しておらず、コンパイルからのコードを実行しているだけです。Polyspace はこのコードブロックにフラグを設定します。@ 記号は入れ子のコメント内にあるため、Polyspace はこのコメントを無視します。

チェック情報

グループ: Code design

カテゴリ: 推奨

AGC カテゴリ: 推奨

バージョン履歴

R2020b で導入

すべて展開する

R2025a: コードを非表示にするコメントがより正確に検出される

Polyspace は、以下に対して違反を報告するようになりました。

C スタイルと C++ スタイル両方のコメントを使用して非表示にされたコード。たとえば、以下のコードスニペットでは違反が発生します。
```
if(v1 == 0) {
	/*do things*/
	// } else if ( v1 + v2 > 10 ) { /* Noncompliant */
	/* do other things */
} else {
	/* last things */
}
```
C スタイルのコメントを使用して非表示にされた関数の引数。以下に例を示します。
```
void foo (int v1, /*int v2,*/ float v3) /* Noncompliant */
{
    //...
}
```
ファイルの最初の行のコメントの直後にある、コメントアウトされた変数宣言。たとえば、このコードでのコメントアウトされた変数宣言は、違反として報告されるようになりました。
```
// @@Variable decalration for module foo
/*int glob1, glob2, glob3;*/ 
```

参考

MISRA C:2012 のチェック (-misra3)

トピック

コーディング規約違反のチェックおよびレビュー

The MISRA coding standards referenced in the Polyspace Bug Finder™ documentation are from the following MISRA standards:

MISRA C:2004
MISRA C:2012
MISRA C:2023
MISRA C++:2008
MISRA C++:2023

MISRA and MISRA C are registered trademarks of The MISRA Consortium Limited 2021.