[Clean Code] 4. 주석

 

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

코드에 주석을 추가하는 일반적인 이유는 코드 품질이 나쁘기 때문이다. 코드가 지저분하면 주석을 달게 아니라 코드를 정리해야 한다!

깔끔하고 주석이 거의 없는 코드가, 복잡하고 주석이 많이 달린 코드보다 훨씬 좋다.

 

코드로 의도를 표현하라!

많은 경우 주석으로 달려는 설명을 코드로 대다수 의도를 표현할 수 있다.

 

좋은 주석

어떤 주석은 필요하거나 유익하다. 몇 가지를 소개한다.

 

<법적인 주석>

때로는 회사가 정립한 구현 표준에 맞춰 법적인 이유로 특정 주석을 넣으라고 명시한다. 예를 들어, 각 소스 파일 첫 머리에 주석으로 들어가는 저작권 정보와 소유권 정보는 필요하고도 타당하다. 다음은 FitNess에서 모든 소스 파일 첫 머리에 추가한 주석이다.

// Copyright (C) 2003,2004,2005 by Object Mentor, Inc. All rights reserved.

 

<정보를 제공하는 주석>

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

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

때때로, 위와 같은 주석이 유용하다 할지라도, 가능하다면, 함수 이름에 정보를 담는 편이 더 좋다. 위 코드는 함수 이름을 responderBeingTested로 바꾸면 주석이 필요 없어진다.

 

<의도를 설명하는 주석>

때떄로 주석은 구현을 이해하게 도와주는 선을 넘어 결정에 깔린 의도까지 설명한다. 다음은 주석으로 흥미로운 결정을 기록한 예제다.

두 객체를 비교할 때 저자는 다른 어떤 객체보다 자기 객체에 높은 순위를 주기로 결정했다.

public int compareTo(Object o) {
    if (o instanceof WikiPagePath) {
        WikiPagePath p = (WikiPagePath) o;
        String compressedName = StringUtil.join(names, "");
        String compressedArgumentName = StringUtil.join(p.names, "");
        return compressedName.compareTo(compressedArgumentName);
    }
    return 1; // 오른쪽 유형이므로 정렬 순위가 더 높다.
}

 

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

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

assertTrue(a.compareTo(a) == 0); // a == a
assertTrue(a.compareTo(b) == 0); // a == b
assertTrue(a.compareTo(b) == -1); // a < b

그러나 위와 같은 주석을 달때는 더 나은 방법이 없는지 고민하고 정확히 달도록 각별히 주의한다.

 

<결과를 경고하는 주석>

다른 프로그래머에게 결과를 경고할 목적으로 주석을 사용한다. 예를 들어, 다음은 특정 테스트 케이스를 꺼야하는 이유를 설명한다.

// 여유 시간이 충분하지 않다면 실행하지 마십시오.
public void _testWithReallyBigFile()
{
    ...        
}

물론 요즘에는 @Ignore 속성을 이용해 테스트 케이스를 꺼버린다. 구체적인 설명은 @Ignore 속성에 문자열로 넣어준다. 

하지만 JUnit4가 나오기 전에는 메서드 이름 앞에 _ 기호를 붙이는 방법이 일반적인 관례였다. 따라서 위에 제시한 주석은 매우 적절한 지적이다.

 

<TODO 주석>

'앞으로 할 일'을 //TODO 주석으로 남겨두면 편하다. 다음은 함수를 구현하지 않은 이유와 미래 모습을 //TODO 주석으로 설명한다.

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

TODO 주석은 당장 구현하기 어려운 업무를 기술한다. 문제를 봐달라는 요청, 더 좋은 이름을 떠올려달라는 부탁, 코드를 고치라는 주의 등에 유용하다. 하지만 시스템에 나쁜 코드를 남겨 놓는 핑계가 되어서는 안 된다.

 

<중요성을 강조하는 주석>

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

String listItemContent = match.group(3).trim();
// 여기서 trim은 정말 중요하다. trim 함수는 문자열에서 시작 공백을 제거한다.
// 문자열에 시작 공백이 있으면 다른 문자열로 인식되기 때문이다.
new ListItemWidget(this, listItemContent, this.level + 1);
return buildList(text.substring(match.end()));

 

<공개 API에서 Javadocs>

설명이 잘 된 공개 API는 참으로 유용하고 만족스럽다. 표준 자바 라이브러리에서 사용한 Javadocs가 좋은 예다. 그러나 여느 주석과 마찬가지로 Javadocs 역시 독자를 오도하거나, 그릇된 정보를 전달할 가능성이 존재한다.

 

나쁜 주석

대다수 주석이 이 범주에 속한다.

 

<주절거리는 주석>

특별한 이유 없이 의무감으로 마지못해 주석을 단다면 전적으로 시간낭비다. 주석을 달기로 결정했다면 충분한 시간을 들여 최고의 주석을 달도록 노력한다.

다음은 FitNess에서 발견한 코드로, 주석을 제대로 달았다면 상당히 유용했을 코드다. 하지만 저자가 그냥 주절거려 놓았기에 판독이 불가능하다.

public void loadProperties() {
    try {
        String propertiesPath = propertiesLocation + "/" + PROPERTIES_FLLE;
        FileInputStream propertiesStream = new FileInputStream(propertiesPath);
        loadedProperties.load(propertiesStream);
    } catch (IOException e) {
        // 속성 파일이 없다면 기본값을 모두 메모리로 읽어 들였다는 의미다.
    }
}

catch 블록에 있는 주석은 무슨 뜻일까? 저자에게야 의미가 있겠지만 그 의미가 다른 사람들에게는 전해지지 않는다. IOException이 발생하면 속성 파일이 없다는 뜻이란다. 그러면 모든 기본값을 메모리로 읽어 들인 상태란다. 하지만 누가 기본값을 읽어 들이는가? load 호출 전? 아니면 load가 예외를 잡아 기본값을 읽어 들인 후 예외를 던지는 건가? 

답을 알아내려면 코드를 뒤져보는 수 밖에 없다. 이해가 안 되어 다른 모듈까지 뒤져야 하는 주석은 독자와 제대로 소통하지 못한다.

 

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

다음은 헤더에 달린 주석이 같은 코드 내용을 그대로 중복한다. 자칫하면 코드보다 주석을 읽는 시간이 더 오래 걸린다.

// this.closed가 true일 때 반환되는 유틸리티 메서드다.
// 타임아웃에 도달하면 예외를던진다.
public synchronized void waitForClose(final long timeoutMillis) throws Exception{
    if (!closed) {
        wait(timeoutMillis);
        if (!closed) {
            throw new Exception("MockResponseSender could not be closed");
        }
    }
}

위와 같은 주석을 달아놓는 목적은 무엇일까? 주석이 코드보다 더 많은 정보를 제공하지 못한다. 코드보다 읽기가 쉽지도 않다.

다음은 톰캣에서 가져온 코드다. 쓸모없고 중복된 Javadocs가 매우 많다. 아래 주석은 코드만 지저분하고 정신 없게 만든다.

/**
 * 이 컴포넌트의 프로세서 지연값
 */
protected int backgroundProcessorDelay = -1;

/**
 * 이 컴퓨넌트를 지원하기 위한 생명주기 이벤트
 */
protected LifeCycleSupport lifecycle - new LifeCycleSupport(this);

...

 

<오해할 여지가 있는 주석>

때때로 의도는 좋았으나 프로그래머가 딱 맞을 정도로 엄밀하게는 주석을 달지 못하기도 한다. "같은 이야기를 중복하는 주석" 에서 언급한 예시를 다시 보자. 예시에서 주석은 중복이 상당히 많으면서도 오해할 여지가 살짝 있다. this.closed가 true로 변하는 순간에 메서드는 반환되지 않는다. this.closed가 true여야 메서드는 반환된다.

(코드보다 읽기도 어려운) 주석에 담긴 '살짝 잘못된 정보'로 인해 this.closed가 true로 변하는 순간에 함수가 반환되리라는 생각으로 어느 프로그래머가 경솔하게 함수를 호출할지도 모른다.

 

<의무적으로 다는 주석>

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

 

<이력을 기록하는 주석>

때때로 사람들은 모듈을 편집할 때마다 모듈 첫머리에 주석을 추가한다. 그리하여 모듈 첫머리 주석은 지금까지 모듈에 가한 변경을 모두 기록하는 일종의 일지가 된다. 당시에는 소스 코드 관리 시스템이 없으니까. 하지만 지금은 혼란만 가중할 뿐이다. 완전히 제거하는 편이 좋다.

 

<있으나 마나 한 주석>

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

/**
 * 월 중 일자를 반환한다.
 *
 * @return 월 중 일자
 */
public int getDayOfMonth() {
    return dayOfMonth;
}

 

<무서운 잡음>

때로는 Javadocs도 잡음이다. 다음은 잘 알려진 오픈 소스 라이브러리에서 가져온 코드다.

/** The name. */
private String name;

/** The version. */
private String version;

/** The licenceName. */
private String licenceName;

/** The version. */
private String info;

여기서 Javadocs는 어떤 목적을 수행할까? 없다. 단지 문서를 제공해야 한다는 잘못된 욕심으로 탄생한 잡음일 뿐이다.

위 주석을 한 번 더 주의 깊게 읽어보자. 잘라서 붙여넣기 오류가 보이는가?

 

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

다음 코드를 살펴보자.

// 전역 목록 <smodule>에 속하는 모듈이 우리가 속한 하위 시스템에 의존하는가?
if (smodule.getDependSubsystems().contains(subSysMod.getSubSystem()))

이 코드에서 주석을 없애고 다시 표현하면 다음과 같다.

ArrayList moduleDependees = smodule.getDependSubsystems();
String ourSubSystem = subSysMod.getSubSystem();
if (moduleDependees.contains(ourSubSystem))

이처럼 주석이 필요하지 않도록 코드를 개선하는 편이 더 좋다.

 

<위치를 표시하는 주석>

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

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

극히 드물지만 위와 같은 배너 아래 특정 기능을 모아놓으면 유용한 경우도 있긴 하다. 하지만 일반적으로 위와 같은 주석은 가독성만 낮추므로 제거해야 마땅하다. 특히 뒷부분에 슬래시(/)로 이어지는 잡음은 제거하는 편이 좋다.'

 

<닫는 괄호에 다는 주석>

때로는 프로그래머들이 닫는 괄호에 특수한 주석을 달아놓는다.

public static void main(String[] args) {
    try {
        while ((line = in.readLine()) != null) {
            lineCount++;
            charCount += line.length();
            String words[] = line.split("\\W");
            wordCount += words.length();
        } //while
        System.out.println("wordCount = " + wordCount);
        System.out.println("lineCount = " + lineCount);
        System.out.println("charCount = " + charCount);
    } //try
    catch (IOException e) {
        System.err.println("Error:" + e.getMessage());
    } //catch
} //main

중첩이 심하고 장황한 함수라면 의미가 있을지도 모르지만 우리가 선호하는 작고 캡슐화된 함수에는 잡음일 뿐이다. 그러므로 닫는 괄호에 주석을 달아야겠다는 생각이 든다면 대신에 함수를 줄이려 시도하자.

 

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

/* 릭이 추가함 */

이런 정보는 소스 코드 관리 시스템에 저장하는 편이 좋다. 이런 주석은 그냥 오랫동안 방치되어 점차 부정확하고 쓸모없는 정보로 변하기 쉽다.

 

<주석으로 처리한 코드>

주석으로 처리한 코드만큼 밉살스러운 관행도 드물다. 다음과 같은 코드는 작성하지 마라!

InputStreamResponse response = new InputStreamResponse();
response.setBody(formatter.getResuptStream(), formatter.getByteCount());
// InputStream resultStream = formatter.getResultStream();
// StreamReader reader = new StreamReader(resultStream);
// response.setContent(reader.read(formatter.getByteCount()));

주석으로 처리된 코드는 다른 사람들이 지우기를 주저한다. 이유가 있어 남겨놓았으리라고. 그래서 질 나쁜 와인병 바닥에 앙금이 쌓이듯이 쓸모 없는 코드가 점차 쌓여간다. 1960년대 즈음에는 주석으로 처리한 코드가 유용했었다. 하지만 이제는 소스 코드 관리 시스템이 우리를 대신해 코드를 기억해준다. 이제 주석으로 처리할 필요가 없다. 그냥 코드를 삭제하라. 잃어버릴 염려는 없다. 약속한다.

 

<HTML 주석>

소스 코드에서 HTML 주석은 혐오 그 자체다. (Javadocs와 같은) 도구로 주석을 뽑아 웹 페이지에 올릴 작정이라면 주석에 HTML 태그를 삽입해야 하는 책임은 프로그래머가 아니라 도구가 져야 한다.

 

<전역 정보>

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

/**
 * 적합성 테스트가 동작하는 포트: 기본값은 <b>8082</b>
 * 
 * @param fitnessPort
 */
public void setFitnessPort(int fitnessPort) {
    this.fitnessPort = fitnessPort;
}

위 주석은 기본 포트 정보를 기술한다. 하지만 함수 자체는 포트 기본값을 전혀 통제하지 못한다. 그러니까 아래 주석은 바로 아래 함수가 아니라 시스템 어딘가에 있는 다른 함수를 설명한다는 말이다.

 

<너무 많은 정보>

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

 

<모호한 관계>

주석과 주석이 설명하는 코드는 둘 사이 관계가 명백해야 한다. 다음은 아파치 commons에서 가져온 주석이다.

/**
 * 모든 픽셀은 담을 만큼 충분한 배열로 시작한다(여기에 필터 바이트를 더한다).
 * 그리고 헤더 정보를 위해 200바이트를 더한다.
 */
this.pngBytes - new byte[((this.width + 1) * this.height * 3) + 200];

여기서 필터 바이트란 무엇일까? +1과 관련이 있을까? 아니면 *3과 관련이 있을까? 한 픽셀이 한 바이트인가? 200을 추가하는 이유는? 주석을 다는 목적은 코드만으로 설명이 부족해서다. 주석 자체가 다시 설명을 요구하니 안타깝기 그지없다.

 

<함수 헤더>

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

 

<비공개 코드에서 Javadocs>

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