SO Tavern 에서이 질문을 보았 으므로 여기에 질문을 게시하고 있습니다. 나는 그것이 흥미로운 질문이라고 생각했다. (물론 SO에 속하지는 않지만 여기서는 괜찮습니다.)
코드 주석에 마침표를 추가합니까 (또는 OP가 쓴 "완전 중지")?
관련성을 유지하려면 왜 그렇 습니까?
답변:
문장 전체는 문장을 끝내기위한 것이지만, 주석이 코드로 둘러싸인 문장 하나만으로 구성되어 있다면, 내 의견으로는 완전한 장소가 필요하지 않습니다. 때로는 첫 글자를 대문자로 표기하지 않을 수도 있습니다. 반면에 여러 줄로 된 주석은 완전한 문장 부호가 필요합니다.
// This function returns an average of two integers. Note that it may
// return an irrelevant result if the sum of a and b exceeds the int
// boundaries.
int avg(int a, int b) // make it static maybe?
{
// A better algorithm is needed that never overflows
return (a + b) / 2;
}
예, 주석은 영어로되어 있고 적절한 영어는 문장 부호를 사용합니다.
코드 주석에 마침표를 추가합니까 (또는 OP가 쓴 "완전 중지")?
관련성을 유지하기 위해 왜?
같은 이유로 나는 "정상적인"텍스트를 쓸 때 그것들을 추가합니다 – 그것들은 글로 쓰는 언어의 일부이며 그들에 특별한 것은 없어야합니다. 한 문장 (한 줄)의 주석과 전체 단락을 쓸 때도 동일하게 사용합니다.
소스 코드는 일반 텍스트가 아니므로 다른 규칙을 사용합니다. 간단한 ;-)
의견을 쓰면 영어로 작성되기를 바랍니다. 이 경우에는 적절하게 문장 부호를 사용해야합니다. 그렇지 않으면 게으르다.
전체 문장 (또는 그 이상)을 쓰면 그렇습니다. 그렇지 않다면 때때로 아니요, 그러나 여전히 그렇습니다.
나는 또한 때때로 미쳐서 느낌표, 물음표 등을 사용합니다.;)
왜 그런지는 부분적으로 내가 그렇게 특별하기 때문이며 부분적으로 적절한 구두점이 많은 명확성을 더할 수 있다는 것을 알기 때문입니다.
따라 다릅니다. 코드 블록의 기능을 설명하는 크고 적절한 단락을 작성하면 다른 적절한 쓰기와 마찬가지로 올바르게 구두점을 만듭니다. OTOH, 한 줄의 코드에 주석을 달면 그렇지 않습니다.
왜? -적절한 글을 사용하여 이메일을 쓰는 이유와 비슷하지만 SMS 메시지에 짧은 문장을 사용할 수 있습니다. 어떤 경우에는 적절한 텍스트 블록을 작성하기 위해 앉아 있습니다. 따라서 자동으로 "적절히 수행"하는 반면, 다른 경우에는 요점을 파악하는 간단한 참고 사항입니다.
내 코드의 실제 예 :
빠른 메모 설명 :
// check for vk_enter
"적절한"방법 문서 :
// This method sets up a workspace tab with the given name. Each MDI window has a parent
// workspace specified when it's saved. The code which loads each MDI window then point it to
// the correct workspace.