주석 (Comments)

주석은 코드를 읽기 쉽게 유지하는 데 절대적으로 중요합니다. 다음 규칙은 주석을 달아야 할 내용과 위치를 설명합니다. 하지만 기억하세요: 주석은 매우 중요하지만 가장 좋은 코드는 자체 문서화입니다. 유형과 변수에 합리적인 이름을 지정하는 것은 주석을 통해 설명해야 하는 모호한 이름을 사용하는 것보다 훨씬 낫습니다.

의견을 작성할 때 청중, 즉 코드를 이해해야 할 다음 기여자를 위해 작성하십시오. 관대하게 대하십시오. 다음 사람은 당신일 수도 있습니다!

---

이해하기 쉽게 설명하기

핵심: 주석은 중요하지만, 최고의 코드는 자기 설명적이다

주석은 코드 가독성에 매우 중요하지만, 가장 좋은 것은 주석 없이도 읽히는 코드입니다. 모호한 이름을 주석으로 설명하느니, 타입과 변수에 좋은 이름을 붙이는 편이 훨씬 낫습니다.

누구를 위해 쓰나

주석은 다음에 이 코드를 이해해야 할 기여자를 위해 쓰세요. 너그럽게 쓰세요 — 그 다음 사람이 미래의 당신일 수도 있습니다.