(Clean Code) 4장 - 주석

• 우리는 코드로 의도를 표현하지 못해 주석을 사용한다
• 주석이 필요한 상황에 처하면 상황을 역전해 코드로 의도를 표현할 방법을 생각하자
• 주석은 오래될수록 코드에서 멀어진다
• 애초에 주석이 필요없는 방향으로 에너지를 쏟아 코드를 깔끔하게 정리하자

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

• 코드에 주석을 추가하는 일반적인 이유는 코드 품질이 나쁘기 때문이다
• 표현력이 풍부하고 깔끔하며 주석이 거의 없는 코드가 좋다

코드로 의도를 표현하라!

• 코드만으로 의도를 설명하기 어려운 경우가 존재한다
• 하지만 많은 경우에서 주석으로 달려는 설명을 함수로 표현해도 충분하다

좋은 주석

• 법적인 주석
• 정보를 제공하는 주석
• 의도를 설명하는 주석
• 의미를 명료하게 밝히는 주석
• 결과를 경고하는 주석
• TODO 주석
• 중요성을 강조하는 주석
• 공개 API에서 Javadocs

나쁜 주석

• 주절거리는 주석
• 같은 이야기를 중복하는 주석
• 오해할 여지가 있는 주석
• 의무적으로 다는 주석
• 이력을 기록하는 주석 (소스관리 시스템을 사용)
• 있으나 마나 한 주석
• 무서운 잡음
• 위치를 표시하는 주석
• 닫는 괄호에 다는 주석
• 공로를 돌리거나 저자를 표시하는 주석
• 주석으로 처리한 코드
• HTML 주석
• 전역 정보
• 너무 많은 정보
• 모호한 관계
• 함수 헤더
• 비공개 코드에서 Javadocs