문장부호, 철자, 문법 (Punctuation, Spelling, and Grammar)¶

구두점, 철자법, 문법에 주의하세요. 잘못 작성된 댓글보다 잘 작성된 댓글을 읽는 것이 더 쉽습니다.

댓글은 적절한 대문자와 구두점을 사용하여 서술형 텍스트만큼 읽기 쉬워야 합니다. 많은 경우, 완전한 문장이 문장 조각보다 더 읽기 쉽습니다. 코드 줄 끝에 있는 주석과 같은 짧은 주석은 때로는 덜 형식적일 수 있지만 스타일은 일관되어야 합니다.

세미콜론을 사용해야 하는데 쉼표를 사용하고 있다는 점을 코드 검토자가 지적하면 실망스러울 수 있지만 소스 코드가 높은 수준의 명확성과 가독성을 유지하는 것이 매우 중요합니다. 적절한 구두점, 철자법, 문법은 해당 목표에 도움이 됩니다.

이해하기 쉽게 설명하기¶

주석은 서술형 텍스트만큼 읽기 쉬워야 합니다 — 올바른 대문자와 문장부호를 쓰고, 대개 완전한 문장이 조각보다 낫습니다. 줄 끝의 짧은 주석은 덜 격식적이어도 되지만 스타일은 일관되게.

세미콜론 대신 쉼표를 썼다고 리뷰어가 지적하면 사소해 보일 수 있지만, 소스 코드의 명확성·가독성을 높은 수준으로 유지하는 것이 중요합니다.