4장 주석
잘 달린 주석은 그 어떤 정보보다 유용하다. 경솔하고근거 없는 주석은 코드를 이해하기 어렵게 만든 다. 오래되고 조잡한 주석은 거짓과 잘못된 정보를 퍼끄려 해악을 미친다.
우리는 코드로 의도를 표현하지 못해, 그러니까 실패를 만회하기 위해 주석을 사용한다.
주석은 언제나 실패를 의미한다.
상황을 역전해 코드로 의도를 표현할 방법은 없을 까?
주석은 오래될수록 코드에서 멀어진다.
프로그래머들이 주석을 유지하고 보수하기란 현실적으로 불가능하다.
부정확한 주석은 아예 없는 주석보다 훨씬 더 나쁘다.
진실은 한곳에만 존재한다. 바로 코드다.
코드만이 정확한 정보를 제공하는 유일한 출처다.
- 주석은 나쁜 코드를 보완하지 못한다.
- 코드에 주석을 추가하는 일반적인 이유는 코드 품질이 나쁘기 때문이다.
- 표현력이 풍부하고 깔끔하며 주석이 거의 없는 코드가, 복잡하고 어수선하며 주석이 많이 달린 코드보다 훨씬 좋다.
- 코드로 의도를 표현하라.
- 좋은 주석
- 정말로 좋은 주석은, 주석을 달지 않을 방법을 찾아낸 주석이다.
- 법적인 주석
- 소스 파일 첫머리에 주석으로 들어가는 저작권 정보와 소유권 정보는 필요하고도 타당하다.
- 정보를 제공하는 주석
- 의도를 설명하는 주석
- 의미를 명료하게 밝히는 주석
- 인수나 반환값이 표준 라이브러리나 변경하지 못하는 코드에 속한다면 의미를 명료하게 밝히는 주석이 유용하다.
- 결과를 경고하는 주석
- TODO 주석
- TODO 주석은 프로그래머가 필요하다 여기지만 당장 구현하기 어려운 업무를 기술한다.
- 중요성을 강조하는 주석
- 공개 API에서 Javadocs
- 설명이 잘 된 공개 API는 참으로 유용하고 만족스럽다.
- 여느 주석과 마찬가지로 Javadocs 역시 독자를 오도하거나, 잘못 위치하거나, 그릇된 정보를 전달할 가능성이 존재한다.
- 나쁜 주석
- 주절거리는 주석
- 주석을 달기로 결정했다면 충분한 시간을 들여 최고의 주석을 달도록 노력한다.
- 이해가 안 되어 다른 모듈까지 뒤져야 하는 주석은 독자와 제대로 소통하지 못하는 주석이다.
- 같은 이야기를 중복하는 주석
- 실제로 코드보다 부정확해 독자가 함수를 대충 이해하고 넘어가게 만든다. 엔진 후드를 열어볼 필요가 없다며 고객에게 아양 떠는 중고차 판매원과 비슷하다.
- 오해할 여지가 있는 주석
- 의무적으로 다는 주석
- 모든함수에 Javadocs를 달거나 모든 변수에 주석을 달아야 한다는 규칙은 어리석기 그지없다.
- 이력을 기록하는 주석
- 있으나 마나 한 주석
- 너무 당연한 사실을 언급하며 새로운 정보를 제공하지 못하는 주석이다.
- 무서운 잡음
- 함수나 변수로 표현할 수 있다면 주석을 달지 마라.
- 위치를 표시하는 주석
- 너무 자주 사용하지 않는 다면 배너는 눈에 띄며 주의를 환기한다. 그러므로 반드시 필요할 때만, 아주 드물게 사용하는 편이 좋다. 배너를 남용하면 독자가 흔한 잡음으로 여겨 무시한다.
- 닫는 괄호에 다는 주석
- 닫는 괄호에 주석을 달아야겠다는 생각이 듣다면 대신에 함수를 줄이려 시도하다.
- 공로를 돌리거나 저자를 표시하는 주석
- 위와 같은 정보는 소스 코드 관리 시스템에 저장하는 편이 좋다.
- 주석으로 처리한 코드
- 주석으로 처리한 코드만큼 밉살스러운 관행도 드물다.
- 주석으로 처리된 코드는 다른 사람들이 지우기를 주저한다. 이유가 있어 남겨 놓았으리라고, 중요하니까 지우면 안 된다고 생각한다.
- 소스 코드 관리 시스템이 우리를 대신해 코드를 기억해준다.
- HTML 주석
- 소스 코드에서 HTML 주석은 혐오 그 자체다.
- Javadocs과 같은 도구로 주석을 뽑아 웹 페이지에 올릴 작정이라면 주석에 HTML 태그를 삽입해야하는 책임은 프로그래머가 아니라 도구가 져야 한다.
- 전역 정보
- 주석을 달아야 한다면 근처에 있는 코드만 기술하라. 코드 일부에 주석을 달면서 시스템의 전반적인 정보를 기술하지 마라.
- 포트 기본값(변수값)을 설정하는 코드가 변해도 아래 주석(전역변수)이 변하리라는 보장은 전혀 없다.
- 너무 많은 정보
- 주석에다 흥미로운 역사나 관련 없는 정보를 장황하게 늘어놓지 마라.
- 모호한 관계
- 주석과 주석이 설명하는 코드는 둘 사이 관계가 명백해야 한다.
- 함수 헤더
- 비공개 코드에서 Javadocs
- 공개 API는 Javadocs가 유용하지만 공개하지 않을 코드라면 Javadocs는 쓸모가 없다.
댓글