[ECCS] 주석에서 허용하는 형식

2. 주석 규정

2.1 주석에서 허용하는 형식

규정

1. C++ 스타일의 단일 행 주석(//으로 시작하는)은 전통적인 C 스타일 주석(/* ... */)의 유용하고 수용 가능한 대안이다.
2. 주석에는 전처리기 토큰(token)인 /*, //, \ 가 포함되지 않아야 한다.
3. 아래 두 경우 일시적으로라도 주석을 작성해서는 안 된다.
   1. 코드 블록을 일시적으로 비활성화하려면 전처리기의 조건부 컴파일 기능을 사용한다(예: #if 0 … #endif).
   2. 디버그 출력 정보의 수준을 높이기 위해 특별히 존재하는 모든 라인 또는 코드 블록은 #ifndef NDEBUG … #endif로 둘러싸야 한다.

예시

/* The following code was meant to be part of the build...
...
safety_checker();
...
/* ... but an end of comment character sequence was omitted. */

이유

의도적이든 아니든 중첩된 주석을 사용하면 컴파일 후 실행할 코드에 대해 코드 검토자를 혼돈케할 위험이 있습니다. assert() 매크로를 비활성화하는 것과도 관련이 있기 때문에 네거티브 로직인 NDEBUG의 사용은 의도적인 것입니다. 두 경우 모두 프로그래머는 장황한 코드를 방지하기 위해 행동합니다.

시행

허용되는 주석 형식만 컴파일러 또는 정적 분석에 의해 부분적으로 적용할 수 있습니다. 그러나 사람인 코드 검토자만이 주석 처리된 코드와 설명적인 코드 스니펫을 포함하는 주석 간의 차이를 구별할 수있습니다.