4장 주석

우리는 코드로 의도를 표현하지 못해, 실패를 만회하기 위해 주석을 사용한다.

주석이 필요한 상황에 처하면 곰곰이 생각하기 바란다. 

=> 상황을 역전해 코드로 의도를 표현할 방법은 없을까?

주석은 나쁜 코드를 보완하지 못한다.

좋은 주석 (그나마 남아있어도 되는 주석?)

- 법적인 주석

- 정보를 제공하는 주석

- 의도를 설명하는 주석

- 의미를 명료하게 밝히는 주석

- 결과를 경고하는 주석

- TODO 주석

- 중요성을 강조하는 주석 (자칫 대수롭지 않다고 여겨질 뭔가의 중요성을 강조하기 위해)

- 공개 API에서 Javadocs

나쁜 주석(대다수 주석...)

- 주절거리는 주석

- 같은 이야기를 중복하는 주석

- 오해할 여지가 있는 주석

- 의무적으로 다는 주석

- 이력을 기록하는 주석 (코드관리 시스템에 맡기자)

- 있으나 마나 한 주석

- 무서운 잡음 (변수에 붙은 The name, The version.. 따위)

- 함수나 변수로 표현할 수 있다면 주석을 달지마라

- 위치를 표시하는 주석 (배너)

- 닫는 괄호에 다는 주석 (닫는 괄호에 주석을 달아야겠다는 생각이 든다면 대신에 함수를 줄여라)

- 공로를 돌리거나 저자를 표시하는 주석

- 주석으로 처리한 코드

- HTML 주석

- 전역 정보 (주석을 달아야 한다면 근처에 있는 코드만 기술하라)

- 모호한 관계 (주석 자체가 다시 설명을 요구하는 경우)

- 함수헤더

- 비공개 코드에서 Javadocs