→ 코드가 명확하게 작성되었다면 주석 없이도 이해할 수 있어야한다.
→ 코드와 불일치 하거나, 쓸모없는 주석은 오히려 코드의 가독성을 떨어뜨린다.
법적인 주석
// Copyright (C) 2003,2004,2005 by Object Memtor, Inc. All rights reserved
라이선스나 저작권과 관련된 주석은 필요하고도 타당하다.
정보를 제공하는 주석
// kk:mm:ss EEE, MMM dd, yyyy 형식이다.
... 정규표현식 코드
정규표현식 같이 코드만 보고 이해하기 어려운 경우에는 타당하다.
의도를 설명하는 주석
// 특정 버전의 라이브러리에서 발생하는 버그를 우회하기 위한 코드
if (connection.isOpen()) {
connection.reset(); // 버그로 인해 close() 대신 reset()을 사용해야 함
}
특정 코드가 왜 존재하는지 다양한 이유로 변경하지 못하는 코드에 속한다면 의미를 명료하게 밝히는 주식은 괜찮다.
결과를 경고하는 주석
// 여유 시간이 충분하지 않다면 실행하지 마십시오.
// SimpleDateFormat은 스레드에 안전하지 못하다.
// 따라서 각 인스턴스를 독립적으로 생성해야한다.