주석

잘 달린 주석은 그 어떤 정보보다 유용하다. 그러나 프로그래밍 언어 자체가 표현력이 풍부하다면, 우리에게 프로그래밍 언어를 사용해 의도를 표현할 능력이 있다면, 주석은 거의 필요하지 않다.
우리는 코드로 의도를 표현하지 못해 주석을 사용한다. 그러므로 주석이 필요한 상황에 처하면 상황을 역전해 코드로 의도를 표현할 방법은 없는지 곰곰이 생각해야 한다.
코드만이 정확한 정보를 제공하는 유일한 출처다. 그러므로 우리는 주석을 가능한 줄이도록 노력해야 한다.

주석은 나쁜 코드를 보완하지 못한다

코드에 주석을 추가하는 일반적인 이유는 코드 품질이 나쁘기 때문이다. 표현력이 풍부하고 깔끔하며 주석이 거의 없는 코드가, 복잡하고 어수선하며 주석이 많이 달린 코드보다 훨씬 좋다.

코드로 의도를 표현하라

코드만으로 의도를 설명하기 어려운 경우가 아니면 주석으로 달려는 설명을 함수로 만들어 표현하는 것이 좋다.

좋은 주석

법적인 주석

회사가 정립한 구현 표준에 맞춰 법적인 이유의 특정 주석

정보를 제공하는 주석

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

// 테스트 중인 Responder 인스턴스를 반환한다.
protected abstract Responder responderInstance();

때로는 위와 같은 주석이 유용하다 할지라도, 가능하다면, 함수 이름에 정보를 담는 편이 좋다.

의도를 설명하는 주석

때때로 주석은 구현을 이해하게 도와주는 것을 넘어 의도까지 설명한다.

// 스레드를 대량 생산하는 방법으로 어떻게든 경쟁 조건을 만들려 시도한다.
for (int i = 0; i < 25000; i++) {
    ...
}

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

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

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

결과를 경고하는 주석

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

public static SimpleDateFormat makeStandardHttpDateFormat() {
    // SimpleDateFormat은 스레드에 안전하지 못하다.
    // 따라서 각 인스턴스를 독립적으로 생성해야 한다.
    SimpleDateFormat df = new SimpleDateFormat("EEE, dd MMM yyyy HH:mm:ss z");
    ...
    return df;
}

TODO 주석

앞으로 할 일을 TODO 주석으로 남겨두면 편하다. 그러나 TODO로 떡칠한 코드는 바람직하지 않다. 그러므로 주기적으로 TODO 주석을 점검해 없애면 좋다.

// TODO-MdM 현재 필요하지 않다.
// 체크아웃 모델을 도입하면 함수가 필요 없다.
protected VersionInfo makeVersion() throws Exception {
    return null;
}

중요성을 강조하는 주석

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

String listItemContent = match.group(3).trim();
// 여기서 trim은 정말 중요하다. trim 함수는 문자열에서 시작 공백을 제거한다.
// 문자열에 시작 공백이 있으면 다른 문자열로 인식되기 때문이다.
...

공개 API에서 Javadocs

공개 API를 구현한다면 반드시 훌륭한 Javadocs를 작성한다. 하지만 여느 주석과 마찬가지로 Javadocs 역시 독자를 오도하거나, 잘못 위치하거나, 그릇된 정보를 전달할 가능성이 존재한다.

나쁜 주석

주절거리는 주석

이해가 안 되어 다른 모듈까지 뒤져야 하는 주석은 독자와 제대로 소통하지 못하는 주석이다.

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

주석이 코드보다 더 많은 정보를 제공하지 못한다. 코드에서 표현이 되었으면 중복해서 주석을 달 필요가 없다.

오해할 여지가 있는 주석

때때로 의도는 좋았으나 프로그래머가 딱 맞을 정도로 엄밀하게는 주석을 달지 못하기도 한다.

의무적으로 다는 주석

모든 함수에 Javadocs를 달거나 모든 변수에 주석을 달아야 한다는 규칙은 어리석지 그지없다. 이런 주석은 코드를 복잡하게 만들며, 거짓말을 퍼뜨리고, 혼동과 무질서를 초래한다.

이력을 기록하는 주석

때때로 사람들은 모듈을 편집할 때마다 모듈 첫머리에 주석을 추가한다. 예전에는 모듈 첫머리에 변경 이력을 기록하고 관리하는 관례가 바람직했다. 당시에는 소스 코드 관리 시스템이 없었기 때문이다. 하지만 이제는 제거하는 편이 좋다.

있으나 마나 한 주석

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

함수나 변수로 표현할 수 있는 주석

위치를 표시하는 주석

소스 파일에서 특정 위치를 표시하려 사용하는 주석이다.

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

위와 같은 배너 아래 특정 기능을 모아놓으면 유용한 경우도 있긴 하다. 하지만 일반적으로 위와 같은 주석은 가독성만 낮추므로 제거해야한다.

닫는 괄호에 다는 주석

때로는 프로그래머들이 닫는 괄호에 특수한 주석을 달아놓는다. 중첩이 심하고 장황한 함수라면 의미가 있을지도 모르지만 작고 캡슐화된 함수에는 불필요하다.

try {
    while () {
        ...
    } // while
    ...
} // try

저자를 표시하는 주석

현실적으로 이런 주석은 오랫동안 코드에 방치되어 점차 부정확하고 쓸모없는 정보로 변하기 쉽다. 소스 코드 관리 시스템으로 대체할 수 있다.

주석으로 처리한 코드

주석으로 처리된 코드는 다른 사람들이 지우기를 주저한다. 이유가 있어 남겨 놓았으리라고, 중요하니까 지우면 안 된다고 생각한다. 그래서 쓸모 없는 코드가 점차 쌓여간다. 소스 코드 관리 시스템이 코드를 기억해주므로 쓸모없다.

HTML 주석

소스 코드에서 HTML 주석은 쓸모가 없다. HTML 주석은 편집기/IDE에서조차 읽기가 어렵다. Javadocs와 같은 도구로 주석을 뽑아 웹 페이지에 올릴 작정이라면 주석에 HTML 태그를 삽입해야 하는 책임은 프로그래머가 아니라 도구가 져야한다.

전역 정보

주석을 달아야 한다면 근처에 있는 코드만 기술하자. 코드 일부에 주석을 달면서 시스템의 전반적인 정보를 기술하면 안 된다.

너무 많은 정보

주석에다 관련 없는 정보를 장황하게 늘어놓지 말자.

모호한 관계

주석과 주석이 설명하는 코드는 둘 사이 관계가 명백해야 한다. 주석을 다는 목적은 코드만으로 설명이 부족해서다.

함수 헤더

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

비공개 코드에서 Javadocs

공개 API는 Javadocs가 유용하지만 공개하지 않을 코드라면 Javadocs는 쓸모 없다. 시스템 내부에 속한 클래스와 함수에 Javadocs를 생성할 필요는 없다.

Categories:

Updated:

Comments