} 이후 코드 블록 끝에서“//…”주석-양호 또는 불량? [닫은]

나는 종종 그러한 주석이 사용되는 것을 보았습니다.

function foo() {
   ...
} // foo

while (...) {
   ...
} // while

if (...) {
   ...
} // if

때로는

if (condition) {
   ...
} // if (condition)

나는이 관행을 이해하지 못하여 적용하지 못했습니다. 코드가 너무 길어서이 엔딩 }이 무엇인지 알아야하는 경우 별도의 함수로 나누는 것이 좋습니다. 또한 대부분의 개발자 도구는 일치하는 대괄호로 이동할 수 있습니다. 그리고 마지막으로, 마지막으로, DRY 원칙에 대한 명백한 위반입니다. 조건을 변경하면 주석도 변경해야한다는 점을 기억해야합니다. 그렇지 않으면 관리자 나 사용자에게 지저분해질 수 있습니다.

사람들은 왜 이것을 사용합니까? 우리는 그것을 사용해야합니까, 아니면 나쁜 습관입니까?

코드가 너무 길어서 괄호를 쉽게 따라갈 수 없다면 대부분의 언어에서 코드를 리팩토링해야합니다.

그러나 PHP와 같은 템플릿 언어에서는 조건 또는 루프 구조의 시작과 끝을 구분하는 큰 HTML 블록이있을 수 있으므로 유효 할 수 있습니다.

그것은 코드 냄새이며 일반적으로 구식 코드 스타일의 숙취입니다. 괜찮은 IDE 리팩토링이 지금보다 더 어렵고 일반적이지는 않았기 때문에 메소드가 길어졌으며 이러한 주석은 더 나은 탐색을 위해 사용되었습니다.

이것은 많은 요인들에 의해 쓸모없는 끔찍한 관행입니다.

• 가장 현대적인 IDE는 캐럿이 기호 중 하나에있을 때 해당 버팀대를 강조 표시합니다.
• 깨끗하게 코딩하는 경우 방법이 10 줄 이상인 곳은 거의 없습니다.

많은 사고 방식을 가진 많은 Java 프로그래머가 Java 코드를 더러워 보이게 만들고 코드에서 벗어나 주석에 집중합니다.

고인 이 사용에 대해 제안한다.

코드는 작성된 것보다 10 배 이상 읽습니다.

읽기가 더 쉬워지면하십시오.

또한이 작업을 수행하는 모든 사람에게 일을 더 쉽게 읽을 수있는 다른 방법을 찾아 보라고 제안합니다. 다른 사람들이 언급 한 리팩토링 기술, 다른 라인의 괄호 등은 모두 좋습니다. 코드가 자체 주석 처리되도록 여러 기능, 메소드 또는 클래스로 분할하는 것도 좋습니다. 대부분의 "ifs"를 제거하고 "for"루프를 명백한 위치에 배치하는 방법도 있으므로이 중 어느 것도 필요하지 않습니다.

그러나 때때로 사람들은 배우고 있습니다. 이것이 그들이하는 일이라면 실제로 코드를 더 읽기 쉽게 만들고 격려하고 다른 관행을 장려합니다. 배우는 사람들은 시작하는 방법에 관계없이 격려를받을 자격이 있으며 격려를받을 것입니다. "이것이 나쁘다"라고 말하는 것이 "이것이 더 낫다"고 말하는 것만 큼 유용하지 않습니다.

이런 종류의 것들로 가득 찬 큰 (C ++) 코드베이스가 있습니다.

int Class::AccessorMethod(void)
{
    return privateValue;
}//end AccessorMethod

이 작은 것의 경우, 이것이 "코드 냄새"를 넘어서 "코드 악취"로 넘어 간다고 말하고 싶습니다. 특히 닫는 괄호를 키 입력과 일치시켜 여는 괄호를 찾을 수있는 IDE에서. 더 긴 방법이 주어지면 여전히 터미널 주석에 중괄호 일치를 사용합니다. 그러한 의견은 나를 산만하게하며, 나는 그것들을 소음으로 생각하는 경향이 있습니다.

C ++에는 여전히 유용한 두 가지 보류가 있으며 "코드 분리"에 대한 조언이 필요하지 않습니다.

1. 네임 스페이스 네임 스페이스는 전체 파일을 포함 할 수 있으며 마지막 괄호는 때때로 사람들을 버릴 수 있으므로 괄호를 나타내는 주석을 추가하면 네임 스페이스를 닫는 것이 유용합니다. 우리 회사의 특정 코딩 스타일의 경우 중요한 것은 네임 스페이스를 들여 쓰지 않기 때문에 중요합니다. 그러한 들여 쓰기는 파일의 공간을 낭비 할 뿐이라고 결정했기 때문입니다.

2. #ifdef / #endif 쌍의 경우. 때로는 조건부 컴파일을위한 많은 코드가 있으며, 중첩으로 인해 불쾌해질 수 있으며, 자주 사용하는 편집기는 들여 쓰기를 "돕고"자주 제거하므로 주석은 빠른 개요 중에 유용합니다.

나를 위해 코드는 지정한 것과 같은 주석을 추가하기가 혼란 스럽습니다.

// IF 문이라고 표시되면. 그런 다음 왜 그것이 처음에 있는지 궁금해합니다.

버팀대가 닫히는 것을 보는 대안은 닫는 것과 같은 열에 여는 것이 있습니다. 나는 훨씬 더 명확하고 읽기 쉽습니다.

이 주석은 오래 전에 공개 되었기 때문에 추적하기 어려운 경우에 유용합니다. 일반적으로 네임 스페이스 (특히 C ++의 익명 네임 스페이스, 컴파일 단위의 구현 세부 사항에 사용되는 네임 스페이스)에 대해서만 발생합니다. 대부분의 경우 닫는 내용이 분명해야합니다.

이것은 특히 EVE와 같은 윈도우 편집기를 사용하는 경우 80x24 문자 터미널 창에서 작업하던 시절에 비해 오래 지속 된 것입니다. 지금도 vim을 사용하여 터미널 세션에서 대부분의 작업을 수행하고 세션을 3 개 또는 4 개의 하위 창으로 분할 할 수 있으므로 한 번에 몇 줄만 볼 수 있습니다.

즉, 두 번 이상 베이컨을 구했을지라도 나는 대회에 온난화되지 않았다. 나는 단지 그것을 소음으로 본다. 루프 또는 조건이 그렇게 커지면 리팩토링을 살펴볼 수 있습니다.

기본적으로 이것을 사용하지 않는 모든 유효한 이유를 제공합니다. 괜찮은 프로그래머라면 누구나 이것을 적용해야합니다. 그래서 왜 않는 사람들은 그것을 사용? 그들이 잘못하고 더 잘 알지 못하기 때문에.