유익한 주석을 주석 처리 된 코드와 구별하는 방법이 있습니까?

프로그래밍 과정 동안 코드를 설명하는 주석과 코드를 제거하는 주석이 생깁니다.

// A concise description 
const a = Boolean(obj);
//b = false;

어느 것을 빨리 파싱하는 좋은 방법이 있습니까?

나는 3을 사용 /하고 /** */설명적인 의견을 가지고 놀았습니다 .

또한 VSCode 플러그인을 사용하여 강조 표시 //TODO:하고//FIXME:

이에 대한 매우 간단한 해결책이 있습니다. 주석 처리 된 코드를 제거하십시오.

실제로 코드를 주석 처리해야하는 이유는 두 가지가 있습니다. 무언가를 테스트하거나 수정하거나 나중에 사용할 수있는 코드를 저장하는 것입니다. 무언가를 테스트하거나 수정하는 경우 테스트 나 수정 작업을 마치면 주석 처리 된 코드를 제거하십시오. 나중에 사용할 수있는 코드를 저장하는 경우에는 일류 코드로 만들어서 잘 사용할 수있는 라이브러리와 같은 곳에 두십시오.

에 추가 RobertHarvey의 훌륭한 대답 @ 의 경우 : 나는 내가 심지어 일시적으로, 소스 제어에 주석 코드를 저장하기 위해 만난 하나의 정당한 이유가 생각 하거나 어떤 이유로 지금은 사용할 수 없습니다 안 비 명백한 교체 코드 . 그럼에도 불구하고 대부분의 주석은 대체 코드가 아닌 설명 이어야합니다 . 이것은 아직 안정되지 않은 버그 또는 언어 기능 일 수 있습니다. 다음과 같이 보일 수 있습니다.

# TODO: Replace with `foo = frobnicate(bar)` once <link.to/bug> is fixed
foo = [some complex workaround]

이 경우 작업이 이미 완료되었지만 아직 활용할 수 없으므로 삭제하면 나중에 다시 검색해야합니다. 동일은 간다 그것의 얼굴에 우수한 것처럼 보일 수 있습니다 최적의 솔루션 또는 유사한 솔루션에 대한 의식이 절충 .

주의 : 대체 솔루션으로 코드를 버리지 마십시오. 모든 작업은 다양한 방법으로 무한대로 수행 될 수 있으며, 변경 될 때마다이 공간을 오랫동안 탐색하는 것은 비용 효율적이 아닙니다. 코드 검토는 동료가 이미 최적이 아닌 것으로 밝혀진 개선 사항을 제안 할 때 그러한 누락 된 주석을 발견하기에 좋은 장소가 될 수 있습니다.

흠, 코드를 주석 처리해야한다고 올바르게 주장하는 Robert 와이 질문을 약간 다르게 읽었습니다.

그러나 나중에 제거하기 위해 코드를 표시하는 규칙을 찾고 있다면 가장 좋아하는 것은 다음과 같습니다.

//b = false; //TODO: remove

일부 IDE의 깃발은 //TODO:논평하거나 가르 칠 수 있습니다. 그렇지 않은 경우 일반적으로 검색 가능한 문자열입니다. 여러 가지 방법으로 상점에서 설정 한 규칙을 따르는 것이 가장 좋습니다. 모든 코드베이스는이 방법을 사용해야합니다. 검색 가능하게 유지합니다.

어느 것을 빨리 파싱합니까?

그 마크가 없으면 자동으로 컴파일러를 사용하는 것입니다. 주석을 제거하면 컴파일되는 코드가 생성되고 주석이 달린 코드 여야합니다. 어렵지 않은지 확인하는 IDE 플러그인 작성. 그러나 버그가있는 주석 처리 된 코드는 남겨 둡니다.

그렇기 때문에 주석 처리 된 코드를 주석 처리하는 순간 코드로 표시하는 것이 좋습니다. 이를 통해 비파괴 적으로 작업 할 수 있으며 실제로 원하는 것을 결정할 수 있습니다. 우리 모두가 방해를 받고 다소 잊혀지기 때문에, 그 상태에있는 동안 일부 회선이 체크인 되어도 놀라지 마십시오. 그들이 그렇게하면 적어도 명확하게 표시되고 검색 가능한 것이 좋습니다. 키보드 매크로는 과거에 도움이되었습니다. 한 번의 키 입력으로 할 수 있다면 중간에 중단되기가 어렵습니다.

지속적인 통합 테스트에서 마크를 밝힐 때까지 이것을 취할 수 있습니다. 죄송합니다. 뛰어난 TODO를 다시 확인하려고합니다.

전 처리기 지시문을 사용하여 주석이 아닌 코드를 제거합니다.

//comment
active_code();
#if FALSE
inactive_code();
#endif

이것은 검색하기가 매우 쉬우 며 구문 강조 표시는 주석으로 처리합니다. 심지어 한 줄로 접을 수도 있습니다.#if FALSE(...)

이 아이디어를 확장하여 몇 가지 옵션을 가질 수 있습니다.

#if OPTION == 0
code_for_option_0();
#elif OPTION == 1
code_for_option_1();
#else
code_for_all_other_options();
#endif

그리고 컴파일 타임 오류 검사 :

#if FOO >= 5
#error FOO should be less than 5!
#endif

물론, 당신은 이것에 대해 넘어 가고 싶지 않거나 실제로 무엇이 컴파일되고 있고 무엇이 그렇지 않은지를 말하기가 어려워집니다. 그러나 아이디어를 얻으면 정적으로 만 사용하는 한 주석 처리 된 코드와 동일한 문제입니다. 당신의 조건이 역동적이라면 더 나쁘다.

기존 코드베이스 에서이 문제를 전혀 고려하지 않은 것을 결정하기 위해 보편적 인 솔루션이 있다고 생각하지 않습니다. 패턴을 직접 찾아서 정규식을 코딩하여 패턴을 찾아야 할 것입니다.

가능한 경우 주석 처리되지 않고 오래된 코드를 제거해야한다는 답변에 동의하지만 주석 처리 된 코드가 필요한 경우에 대한 규칙을 준수했습니다.

(내 기초는 C #이지만 Java와 같은 모든 C 구문 언어에 적용될 수 있습니다)

// An explanatory comment has a space between the comment marker and the content.

// The following lines are commented out code so do not have the space (except where indented).
//var a = something();
//if(a==2) {
//   doSomethingElse();
//}

주석이 달린 코드를 찾으려고 생각하면서 여전히 다른 질문을 해석하고 있습니다.

C 스타일 코드에는 세미콜론이 포함되어 있지만 주석에는 세미콜론이 포함되어 있지 않습니다. 따라서 한 줄 주석 처리 된 코드의 경우이 정규 표현식을 사용할 수 있습니다.

\s*\/\/[\s\S]*;

여러 줄 주석 처리 된 코드의 경우

\/\*[^\;]*;[^\;]*\*\/

참고 Visual Studio는 정규 표현식의 줄 바꿈에 대해 약간 특이하며 공백으로 계산되지 않으므로 명시적인 \ n을 지정해야합니다.

Xcode 및 Clang과 같이 백그라운드에서 실행되는 컴파일러에서 편집기를 사용하는 경우 주석 텍스트를 컴파일하면됩니다. 예를 들어 "간결한 설명"은 "b = false;"오류를 제공합니다. 그런 다음 다른 구문 강조를 사용할 수 있습니다.

더 간단한 방법은 키워드 포인트 주석, 중괄호 포인트 코드 간 일치 등 여러 행의 여러 단어와 같은 휴리스틱을 사용하는 IDE 플러그인입니다.

다른 답변은 "코드 주석 처리 안 함"테마에 대한 변형을 다루었습니다. 그러나 때로는 참조를 위해 여전히 원합니다.

코드를 진정으로 유지해야하는 경우 더 나은 해결책은 코드를 "#if 0 ... #endif"로 묶는 것이 이상적입니다. MISRA를 포함한 다양한 코딩 표준에서 권장되는 전략입니다.

최소한 나에게는 간단하고 C / C ++에서는 간단합니다. / * * /에 포함 된 주석은 유익합니다. 일시적으로 제거 된 테스트 코드는 //로 주석 처리됩니다.

그리고 테스트 코드를 파일에 남겨 두어야 할 이유가 있지만 적어도 내가하는 일에서 주석 처리했습니다. 조만간 누군가가 변경을 원할 것인데, 그 코드가 필요합니다. 블록의 주석 처리를 제거하면 완료된 위치에서 주석 처리를 해제하는 것처럼 하나의 편집기 명령이 필요합니다.