- 사실상 주석은 기껏해야 필요악이다.
- 우리는 코드로 의도를 표현하지 못해, 그러니까 ‘실패’를 만회하기 위해 주석을 사용한다.
- 주석은 언제나 실패를 의미한다.
- 프로그래머들이 주석을 유지하고 보수하기란 현실적으로 불가능하다.
- 코드는 변화하고 진화하지만, 불행하게도 주석이 언제나 코드를 따라가지는 못한다.
- 우리는 (간혹 필요할지라도) 주석을 가능한 줄이도록 꾸준히 노력해야 한다.
주석은 나쁜 코드를 보완하지 못한다
- 자신이 저지른 난장판을 주석으로 설명하려 애쓰는 대신에 그 난장판을 깨끗이 치우는 데 시간을 보내라!
코드로 의도를 표현하라!
- 코드만으로 의도를 설명하기 어려운 경우가 존재한다는 생각은 분명히 잘못된 생각이다.
- 나쁜 예)
// 직원이 복지 혜택을 받을 자격이 있는지 검사한다.
if ((employee.flags & HOURLY_FLAG) &
(employee.age > 65))
if (employee.isEligibleForFullBenefits())
좋은 주석
- 법적인 주석
- 회사가 정립한 구현 표준에 맞춰 법적인 이유로 특정 주석을 넣으라고 명시하는 경우
- 각 소스 파일 첫머리에 주석으로 들어가는 저작권 정보와 소유권 정보 등
- 정보를 제공하는 주석
- 코드만 봐도 알 수 있는 내용을 부연 설명 (주석이 필요없게 만드는 것이 더 좋음)
- 의도를 설명하는 주석
- 구현을 이해하게 도와주는 선을 넘어 결정에 깔린 의도까지 설명한다.
- 의미를 명료하게 밝히는 주석
- 때때로 모호한 인수나 반환값은 그 의미를 읽기 좋게 표현하면 이해하기 쉬워진다.
- 하지만 주석이 올바른지 검증하기 쉽지 않다.
- 결과를 경고하는 주석
- 요즘에는 @Ignore 속성을 이용해 테스트 케이스를 꺼버린다.
- junit4 : @Ignore(“실행이 너무 오래 걸린다”)
- junit5 : @Disable(“실행이 너무 오래 걸린다”)
- JUnit4가 나오기 전에는 메서드 이름 앞에 _기호를 붙이는 방법이 일반적인 관례였다.
// 여유 시간이 충분하지 않다면 실행하지 마십시오.
public void _testWithReallyBigFile(){
매우 시간이 오래 걸리는 코드
}
- TODO 주석
- 중요성을 강조하는 주석
- 공개 API에서 Javadocs
나쁜 주석
- 주절거리는 주석
- 특별한 이유 없이 의무감으로 혹은 프로세스에서 하라고해서 단 주석
- 같은 이야기를 중복하는 주석
- 주석이 코드보다 더 많은 정보를 제공하지 못한다.
- 오해할 여지가 있는 주석
- 의무적으로 다는 주석
- 모든 함수에 Javadocs를 달거나 모든 변수에 주석
- 이력을 기록하는 주석
- 이제는 소스 코드 관리 시스템이 있기 때문에 이력 주석은 완전히 제거하는 편이 좋다.
- 있으나 마나 한 주석
- 너무 당연한 사실을 언급하며 새로운 정보를 제공하지 못하는 주석
- 무서운 잡음
- 때때로의 Javadocs : 단지 문서를 제공해야 한다는 잘못된 욕심으로 탄생한 잡음같은 주석
- 함수나 변수로 표현할 수 있다면 주석을 달지 마라
- 위치를 표시하는 주석
- e.g.) // 이 부분부터 로직 실행!! ////////////////////////////////////////////////////
- 반드시 필요할 때만, 아주 드물게 사용하는 편이 좋다.
- 닫는 괄호에 다는 주석
- 닫는 괄호에 주석을 달아야겠다는 생각이 든다면 대신에 함수를 줄이려 시도하자.
- 공로를 돌리거나 저자를 표시하는 주석
- 주석으로 처리한 코드
- 이유가 있어 남겨놓았으리라고, 중요하니까 지우면 안 된다고 생각한다.
- 소스 코드 관리 시스템이 우리를 대신해 코드를 기억해준다.
- 그냥 코드를 삭제하라.
- HTML 주석
- 소스 코드에서 HTML 주석은 혐오 그 자체다.
- HTML 주석은 (주석을 읽기 쉬워야 하는) 편집기/IDE에서조차 읽기가 어렵다.
- 전역 정보
- 주석을 달아야 한다면 근처에 있는 코드만 기술하라.
- 코드 일부에 주석을 달면서 시스템의 전반적인 정보를 기술하지 마라.
- 너무 많은 정보
- 주석에다 흥미로운 역사나 관련 없는 정보를 장황하게 늘어놓지 마라.
- 모호한 관계
- 주석과 주석이 설명하는 코드는 둘 사이 관계가 명백해야 한다.
- 함수 헤더
- 비공개 코드에서 Javadocs