클린코드 #4 주석


프로그래밍 언어로 의도를 표현할 능력이 있다면 주석은 필요하지 않다. 주석은 실패를 의미한다. 코드는 변화하는 반면 주석은 코드를 따라가지 못한다. 부정확한 주석은 아예 없는 주석보다 나쁘다.

좋은 주석

정말로 좋은 주석은, 주석을 달지 않을 방법을 찾아낸 주석이다.

법적인 주석

때로는 회사가 정립한 구현 표준에 맞춰 법적인 이유로 특정 주석을 넣으라고 명시한다.

  • 예: 각 소스 파일 첫머리에 주석으로 들어가는 저작권 정보와 소유권 정보는 타당하다

정보를 제공하는 주석

때로는 기본적인 정보를 주석으로 제공하면 편리하다.

// 테스트 중인 Responder 인스턴스를 반환한다.
protected abstract Responder responderInstance();
  • 함수 이름에 정보를 담는 편이 더 좋다. 위 코드는 함수 이름을 responderBeingTested로 바꾸면 주석이 필요없어진다.
// kk:mm:ss EEE, MMM dd, yyyy 형식이다.
Pattern timeMatcher = Pattern.compile(
"\\d*:\\d*:\\d* \\w*, \\w* \\d*, \\d*"
);
  • 위 주석은 코드에서 사용한 정규표현식이 시각과 날짜를 뜻한다고 설명한다.
  • 시각과 날짜를 변환하는 클래스를 만들어 코드를 옮겨주면 주석이 필요없어진다.

의도를 설명하는 주석

때때로 주석은 구현을 이해하게 도와주는 선을 넘어 결정에 깔린 의도까지 설명한다. 예를 들어 두 객체를 비교할 때 저자는 다른 어떤 객체보다 자기 객체에 높은 순위를 주기로 결정했다.

// 스레드를 대량 생성하는 방법으로 어떻게든 경쟁 조건을 만들려 시도한다.

의미를 명료하게 밝히는 주석

때때로 모호한 인수나 반환값은 그 의미를 읽기 좋게 표현하면 이해하기 쉬워진다. 인수나 반환값 자체를 명확하게 만들면 더 좋겠지만, 인수나 반환값이 표준 라이브러리나 변경하지 못하는 코드에 속한다면 의미를 명료하게 밝히는 주석이 유용하다.

assertTrue(a.compareTo(a) == 0);  // a === a

주석이 올바른지 검증하기 쉽지 않기 때문에 이러한 주석은 위험할 수 있다. 그러므로 위와 같은 주석을 달 때는 더 나은 방법이 없는지 고민하고 정확히 달도록 주의해야 한다.

결과를 경고하는 주석

때로 다른 프로그래머에게 결과를 경고할 목적으로 주석을 사용한다.

아래는 특정 테스트 케이스를 꺼야하는 이유를 설명하는 주석이다.

// 여유 시간이 풍분하지 않다면 실행하지 마십시오. 

요즘에는 주석대신 @Ignore 속성을 이용해 테스트 케이스를 꺼버린다.

TODO 주석

때로는 '앞으로 할 일'을 //TODO 주석으로 남겨두면 편하다. TODO주석은 프로그래머가 필요하다 여기지만 당장 구현하기 어려운 업무를 기술한다.

예를 들면 더 이상 필요없는 기능을 삭제하라는 알림, 문제를 봐달라는 요청, 더 좋은 이름을 떠올려달라는 부탁, 앞으로 발생할 이벤트에 맞춰 코드를 고치라는 주의 등에 유용하다.

주기적으로 TODO 주석을 점검해 없애도 괜찮은 주석은 없애자.

중요성을 강조하는 주석

자칫 대수롭지 않다고 여겨질 뭔가의 중요성을 강조하기 위해서도 주석을 사용한다.

나쁜 주석

대다수 주석이 이 범주에 속한다. 일반적으로 대다수 주석은 허술한 코드를 지탱하거나, 엉성한 코드를 변명하거나, 미숙한 결정을 합리화하는 등 프로그래머가 주절거리는 독백에서 크게 벗어나지 못한다.

주절거리는 주석

주석을 읽고 답을 알아내기 위해 다른 코드를 뒤져보게 만든다면 나쁜 주석이라고 할 수 있다. 이러한 주석은 바이트만 낭비할 뿐이다. 주석을 달기로 결정했다면 충분한 시간을 들여 최고의 주석을 달도록 노력한다.

같은 이야기를 중복하는 주석

주석이 같은 코드 내용을 그대로 중복한다면 코드보다 주석을 읽는 시간이 더 오래걸릴 수 있다. 주석이 코드보다 더 많은 정보를 제공하지 못한다. 이러한 주석은 엔진 후드를 열어볼 필요가 없다며 고객에게 아양 떠는 중고차 판매원과 비슷하다 (!!)

오해할 여지가 있는 주석

때때로 의도는 좋았으나 프로그래머가 딱 맞을 정도로 엄밀하게는 주석을 달지 못한기도 한다. 주석에 담긴 살짝 잘못된 정보로 인해 어느 프로그래머가 경솔하게 함수를 호출할지도 모른다.

의무적으로 다는 주석

모든 함수에 Javadocs를 달거나 모든 변수에 주석을 달아야 한다는 규칙은 어리석다. 이런 주석은 코드를 복잡하게 만들고 무질서를 초래한다.

이력을 기록하는 주석

때때로 사람들은 모듈을 편집할 때마다 모듈 첫머리에 주석을 추가한다. 그리하여 모듈 첫머리 주석은 지금까지 모듈에 가한 변경을 모두 기록하는 일종의 일지 혹은 로그가 된다.

예전에는 모든 모듈 첫머리에 변경 이력을 기록하고 관리하는 관례가 바람직했지만 이제는 혼란만 가증할 뿐이다.

있으나 마나 한 주석

때때로 있으나 마나 한 주석을 접한다. 너무 당연한 사실을 언급하며 새로운 정보를 제공하지 못하는 주석이다.

// 월 중 일자를 반환한다.
@ return 월 중 일자

있으나 마나 한 주석을 달려는 유혹에서 벗어나 코드를 정리하라.

함수나 변수로 표현할 수 있다면 주석을 달지마라

주석을 없애고 함수나 변수로 표현하자

위치를 표시하는 주석

때때로 프로그래머는 소스 파일에서 특정 위치를 표시하려 주석을 사용한다.

// Actions /////////////////////////////////////////

너무 자주 사용하지 않는다면 배너는 눈에 띄며 주의를 환기한다. 그러므로 반드시 필요할 때만, 아주 드물게 사용하는 편이 좋다. 배너를 남용하면 독자가 흔한 잡음으로 여겨 무시한다.

닫는 괄호에 다는 주석

때로는 프로그래머들이 닫는 괄호에 특수한 주석을 달아놓는다. 중첩이 심하고 장황한 함수라면 의미가 있을지 모르지만 작고 캡슐화된 함수에는 잡음일 뿐이다. 대신 함수를 줄이자

공로를 돌리거나 저자를 표시하는 주석

/* 릭이 추가함 */

위와 같은 정보는 소스 코드 관리시스템에 저장하는 편이 좋다.

주석으로 처리한 코드

주석으로 처리한 코드는 사람들이 지우기를 주저한다. 이유가 있어 남겨놓았으리라고, 중요하니까 지우면 안 된다고 생각한다. 그래서 쓸모 없는 코드가 점차 쌓여간다. 주석으로 코드를 처리하지말고 코드를 삭제하라. 잃어버릴 염려는 없다.

HTML 주석

소스코드에서 HTML 주석은 혐오 그 자체다. HTML 태그를 삽입해야하는 책임은 프로그래머가 아니라 도구가 져야한다.

전역 정보

주석을 달아야 한다면 근처에 있는 코드만 기술하라. 코드 일부에 주석을 달면서 시스템의 전반적인 정보를 기술하지 마라. 예를 들어, 포트 기본값을 설정하는 코드가 변해도 주석이 변하리라는 보장이 없으니 포트 정보는 기술하지 않는 편이 좋다.

너무 많은 정보

주석에다 흥미로운 역사나 관련 없는 정보를 장황하게 늘어놓지 마라.

모호한 관계

주석과 주석이 설명하는 둘 사이 관계가 명백해야 한다. 주석 자체가 다시 설명을 요구한다면 좋지 않다.

함수 헤더

짧은 함수는 긴 설명이 필요 없다. 짧고 한가지만 수행하며 이름을 잘 붙인 함수가 주석으로 헤더를 추가한 함수보다 훨씬 좋다.

비공개 코드에서 Javadocs

공개용 API에서는 유용하지만 공개하지 않을 코드라면 쓸모 없다.