냄새와 휴리스틱 - 주석

휴리스틱 : 불충분한 시간이나 정보로 인하여 합리적인 판단을 할 수 없거나, 체계적이면서 합리적인 판단이 굳이 필요하지 않은 상황에서 사람들이 빠르게 사용할 수 있게 보다 용이하게 구성된 간편추론의 방법이다.

C1 : 부적절한 정보

• 소스 코드 관리 시스템, 버그 추적 시스템, 이슈 추적 시스템, 기타 기록관리 시스템에 저장할 정보는 주석으로 넣지 않는다.
• 작성자, 최종 수정일, SPR 번호 등 메타 정보 이외에는 보통 불필요.
• 주석은 코드와 설계에 기술적인 설명을 부연하는 수단.

C2 : 쓸모없는 주석

• 오래된 주석, 엉뚱한 주석, 잘못된 주석은 쓸모없다.

C3 : 중복된 주석

• 코드만으로 충분한 내용을 중복해서 설명하는 주석.
• 서명 (signature) 만 달랑 있는 Javadoc

C4 : 성의 없는 주석

• 단어, 문법, 구두점을 신경써서 간결하고 명료하게 작성한다.

C5 : 주석 처리된 코드

• 주석으로 처리된 코드는 누가 어떤의도로 남겼는지 알 수 없다.
• 따라서 아무도 삭제하지 않고 의미있는 것인냥 남아서 모듈을 오염시킨다.
• 주석 처리된  코드는 그냥 지워버려라 ! 어짜피 코드관리시스템이 기억한다.