나쁜 코드에 주석을 달지 마라. 새로 짜라.
-브라이언 W. 커니핸, P.J. 플라우거
사실상 주석은 기껏해야 필요악이다.
...(중략)
주석은 언제나 실패를 의미한다.
위 두 문장을 통해 알 수 있듯, 이 책은 주석에 굉장히 회의적입니다.
주석으로 말하지 말고, 함수로 말하라는 것이 이 챕터의 전반적인 내용입니다.
그럼에도 불구하고 저자가 용인하는 주석이 몇가지 있긴 합니다.
그 중에서도 대부분은 주석이 아니라 함수로 처리할 수 있다면 처리하는 것이 좋다고 얘기하는데,
주석 외에 다른 방법으로는 도저히 처리할 수 없다고 나와있는 것들만 소개하겠습니다.
- 법적인 주석
- 결과를 경고하는 주석
- TODO 주석
- 중요성을 강조하는 주석
다음은 책에서 좋은 주석으로 소개되고 있으나, 가능하다면 주석을 사용하지 않는 것이 더 좋다고 소개된 것들입니다.
- 정보를 제공하는 주석
- 의도를 설명하는 주석
- 의미를 명료하게 밝히는 주석
잘못된 주석은 없느니만 못합니다. 게다가 주석은 검증하기 어렵습니다. 이에 따라 클린코드에서는 주석을 최대한 사용하지 않을 것을 권장하고 있습니다.
개발자의 언어는 결국 주석이 아니라, 코드입니다!
Java/Spring Back-End Developer