나쁜 코드에 주석을 달지 마라. 새로 짜라. (브라이언 W. 커니핸, P.J.플라우거)
- 잘 달린 주석은 그 어떤 정보보다 유용하다.
- 경솔하고 근거 없는 주석은 코드를 이해하기 어렵게 만든다.
- 오래되고 조잡한 주석은 거짓과 잘못된 정보를 퍼뜨려 해악을 미친다.
- 주석은
순수하게 선하지못하다.
우리에게 프로그래밍 언어를 치밀하게 사용해 의도를 표현할 능력이 있다면, 주석은 거의 필요하지 않으리라. 아니, 전혀 필요하지 않으리라.
우리는 코드로 의도를 표현하지 못해, 그러니까실패를 만회하기 위해 주석을 사용한다.
- 때때로 주석 없이는 자신을 표현할 방법을 찾지 못해 할 수 없이 주석을 사용한다.
- 그래서 주석은 반겨 맞을 손님이 아니다.
- 그러므로 주석이 필요한 상황에 처하면 곰곰이 생각하기 바란다.
상황을 역전해 코드로 의도를 표현할 방법은 없을까?
코드로 의도를 표현할 때마다 스스로를 칭찬해준다.
주석을 달 때마다 자신에게 표현력이 없다는 사실을 푸념해야 마땅하다.
- 주석은 항상도 아니고 고의도 아니지만 자주 거짓말을 한다.
- 오래될수록 코드에서 멀어지고, 완전히 그릇될 가능성도 커진다.
- 프로그래머들이 주석을 유지하고 보수하기란 현실적으로 불가능하기 때문!
- 코드는 변화하고 진화하지만, 불행하게도 주석이 언제나 코드를 따라가지는 않는다.
주석은 나쁜 코드를 보완하지 못한다.
코드에 주석을 추가하는 일반적인 이유는 코드 품질이 나쁘기 때문이다.
표현력이 풍부하고 깔끔하며 주석이 거의 없는 코드가, 복잡하고 어수선하며 주석이 많이 달린 코드보다 훨씬 좋다.
자신이 저지른 난장판을 주석으로 설명하려 애쓰는 대신에 그 난장판을 깨끗이 치우는 데 시간을 보내라!
코드로 의도를 표현하라
// 직원에게 복지 혜택을 받을 자격이 있는지 검사한다.
if ((employee.flags & HOURLY_FLAG) &&
(employee.age > 65))
if (employee.isEligibleForFullBenefits())- 위와 같이 몇 초만 더 생각하면 코드로 대다수 의도를 표현할 수 있다.
- 많은 경우 주석을 달려는 설명을 함수로 만들어 표현해도 충분하다.
좋은 주석
어떤 주석은 필요하거나 유익하다.
법적인 주석
때로는 회사가 정립한 구현 표준에 맞춰 법적인 이유로 특정 주석을 넣으라고 명시한다.
예를 들어, 각 소스 파일 첫머리에 주석으로 들어가는 저자권 정보와 소유권 정보는 필요하고도 타당하다.
- 소스 파일 첫머리에 들어가는 주석이 반드시 계약 조건이나 법적인 정보일 필요는 없다.
- 모든 조항과 조건을 열거하는 대신에, 가능하다면, 표준 라이선스나 외부 문서를 참조해도 되겠다.
정보를 제공하는 주석
때로는 기본적인 정보를 주석으로 제공하면 편리하다.
- 다음 주석은 추상 메서드가 반환할 값을 설명한다.
// 테스트 중인 Responder 인스턴스를 반환한다.
protected abstract Responder responderInstance();- 때때로 위와 같은 주석이 유용하다 할지라도, 가능하다면, 함수 이름에 정보를 담는 편이 더 좋다.
- 위 코드는 함수 이름을
responderBeingTested로 바꾸면 주석이 필요 없어진다.
// kk:mm:ss EEE, MMM dd, yyyy 형식이다.
Pattern timeMatcher = Pattern.compile("\\d*:\\d*:\\d* \\w*, \\w* \\d*, \\d*");- 위에 제시한 주석은 코드에서 사용한 정규표현식이 시각과 날짜를 뜻한다고 설명한다.
- 이 역시 이왕이면 시각과 날짜를 변환하는 클래스를 만들어 코드를 옮겨주면 더 좋고 더 깔끔하겠다.
의도를 설명하는 주석
- 때때로 주석은 구현을 이해하게 도와주는 선을 넘어 결정에 깔린 의도까지 설명한다.
의미를 명료하게 밝히는 주석
- 때때로 모호한 인수나 반환값은 그 의미를 읽기 좋게 표현하면 이해하기 쉬워진다.
- 일반적으로는 인수나 반환값 자체를 명확하게 만들면 더 좋겠지만, 인수나 반환값이 표준 라이브러리나 변경하지 못하는 코드에 속한다면 의미를 명료하게 밝히는 주석이 유용하다.
- 물론 그릇된 주석을 달아놓을 위험은 상당히 높다.
결과를 경고하는 주석
- 때로 다른 프로그래머에게 결과를 경고할 목적으로 주석을 사용한다.
// 여유 시간이 충분하지 않다면 실행하지 마십시오.
public void _testWithReallyBigFile(){
...
}TODO 주석
- 때로는 '앞으로 할 일' 을 // TODO 주석으로 남겨두면 편하다.
- TODO 주석은 프로그래머가 필요하다 여기지만 당장 구현하기 어려운 업무를 기술한다.
- 더 이상 필요 없는 기능을 삭제하라는 알림, 누군가에게 문제를 봐달라는 요청, 더 좋은 이름을 떠올려달라는 부탁, 앞으로 발생할 이벤트에 맞춰 코드를 고치라는 주의 등에 유용하다.
- 하지만 어떤 용도로 사용하든 시스템에 나쁜 코드를 남겨 놓는 핑계가 되어서는 안 된다.
중요성을 강조하는 주석
공개 API에서 Javadocs
나쁜 주석
- 대다수 주석이 이 범주에 속한다.
- 일반적으로 대다수 주석은 허술한 코드를 지탱하거나, 엉성한 코드를 변명하거나, 미숙한 결정을 합리화하는 등 프로그래머가 주절거리는 독백에서 크게 벗어나지 못한다.
주절거리는 주석
- 특별한 이유 없이 의무감으로 혹은 프로세스에서 하라고 하니까 마지못해 주석을 단다면 전적으로 시간낭비다.
같은 이야기를 중복하는 주석
오해할 여지가 있는 주석
- 주석에 담긴 '살짝 잘못된 정보'로 인해 어느 프로그래머가 경솔하게 함수를 호출할지도 모른다.
의무적으로 다는 주석
- 모든 함수에 Javadocs를 달거나 모든 변수에 주석을 달아야 한다는 규칙은 어리석기 그지없다.
- 이런 주석은 코드를 복잡하게 만들며, 거짓말을 퍼뜨리고, 혼동과 무질서를 초래한다.
이력을 기록하는 주석
- 예전에는 모든 모듈 첫머리에 변경 이력을 기록하고 관리하는 관례가 바람직했으나, 이제는 혼란만 가중할 뿐이다. 완전히 제거하는 편이 좋다.
있으나 마나 한 주석
- 너무 당연한 사실을 언급하며 새로운 정보를 제공하지 못하는 주석
무서운 잡음
함수나 변수로 표현할 수 있다면 주석을 달지 마라
위치를 표시하는 주석
- 소스 파일에서 특정 위치를 표시하려 주석을 사용한다.
닫는 괄호에 다는 주석
- 중첩이 심하고 장황한 함수라면 의미가 있을지도 모르지만 작고 캡슐화된 함수에는 잡음일 뿐이다.
- 그러므로 닫는 괄호에 주석을 달아야겠다는 생각이 든다면 대신에 함수를 줄이려 시도하자.
공로를 돌리거나 저자를 표시하는 주석
- 저자 이름으로 코드를 오염시킬 필요가 없다.
주석으로 처리한 코드
- 주석으로 처리한 코드만큼 밉살스러운 관행도 드물다.
- 주석으로 처리된 코드는 다른 사람들이 지우기를 주저한다.
- 이유가 있어 남겨놓았으리라고, 중요하니까 지우면 안 된다고 생각한다.
- 이제는 소스 코드 관리 시스템이 코드를 기억하기에 주석으로 처리할 필요가 없다.
HTML 주석
- 소스 코드에서 HTML 주석은 혐오 그 자체다.
전역 정보
- 주석을 달아야 한다면 근처에 있는 코드만 기술하라.
- 코드 일부에 주석을 달면서 시스템의 전반적인 정보를 기술하지 마라.
너무 많은 정보
- 주석에다 흥미로운 역사나 관련 없는 정보를 장황하게 늘어놓지 마라.
모호한 관계
- 주석과 주석이 설명하는 코드는 둘 사이 관계가 명백해야 한다.
함수 헤더
- 짧은 함수는 긴 설명이 필요 없다.
- 짧고 한 가지만 수행하며 이름을 잘 붙인 함수가 주석으로 헤더를 추가한 함수보다 훨씬 좋다.
비공개 코드에서 Javadocs
- 공개 API는 Javadocs가 유용하지만 공개하지 않을 코드라면 쓸모가없다.
jh