주석은 나쁜코드를 보완하지 못한다
- 표현력이 풍부하고 깔끔하며 주석이 거의 없는 코드가, 복잡하고 어수선하며 주석이 많이 달린 코드보다 훨씬 좋다
코드로 의도를 표현하라!
좋은 주석
법적인 주석
정보를 제공하는 주석
의도를 설명하는 주석
의미를 명료하게 밝히는 주석
결과를 경고하는 주석
TODO 주석
중요성을 강조하는 주석
공개 API에서 Javadocs
나쁜 주석
주절거리는 주석
같은 이야기를 중복하는 주석
의무적으로 다루는 주석
이력을 기록하는 주석
있으나 마나 한 주석
무서운 잡음
함수나 변수로 표현할 수 있다면 주석을 달지 마라
닫는 괄호에 다는 주석
주석으로 처리한 코드
HTML 주석
전역 정보
너무 많은 정보
모호한 관계
함수 헤더
비공개 코드에서 Javadocs
References