[Clean Code] 4. 주석 - 클린 코드 정독하기

나쁜 코드에 주석을 달지 마라. 새로 짜라. - 브라이언 W. 커니핸, P.J. 플라우거

 

Intro

사실상 주석은 필요하지 않다. 우리에게 프로그래밍 언어를 치밀하게 사용해 의도를 표현할 능력이 있다면, 주석은 필요하지 않다.

• 우리는 코드로 의도를 표현하지 못한 것을 만회하기 위해 주석을 사용한다.
• 주석을 달 때마다 자신에게 표현력이 없다는 사실을 푸념해야 마땅하다.

 

주석은 자주 거짓말을 한다. 주석은 오래될수록 코드에서 멀어진다. 오래될수록 완전히 그릇될 가능성도 커진다.

• 프로그래머들이 주석을 유지하고 보수하기란 현실적으로 불가능하기 때문이다.
• 코드는 변화하고 진화한다. 여기저기로 옮겨지기도 하고, 조각이 나뉘고 합쳐지기도 한다.
• 불행하게도 주석이 언제나 코드를 따라가지 못한다.

 

진실은 한 곳에만 존재한다. 바로 코드다. 코드만이 자기가 하는 일을 진실되게 말한다. 코드만이 정확한 정보를 제공하는 유일한 출처다. 그러므로 우리는 주석을 가능한 줄이도록 꾸준히 노력해야 한다.

 

 

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

코드에 주석을 추가하는 일반적인 이유는 코드 품질이 나쁘기 때문이다.

• 주석을 다는 것이 아닌 코드를 정리해야 한다.
• 표현력이 풍부하고 깔끔하며 주석이 거의 없는 코드가, 복잡하고 어수선하며 주석이 많이 달린 코드보다 훨씬 좋다.

 

 

코드로 의도를 표현하라!

주석이 달린 코드

// 직원에게 복지 혜택을 받을 자격이 있는지 검사한다.
if ((employee.flags & HOURLY_FLAG) && (employee.age > 65)

 

코드로 의도를 표현한 경우

if (employee.isEligibleForFullBenefits())

• 많은 경우 주석으로 달려는 설명을 함수로 만들어 표현해도 충분하다.

 

 

좋은 주석

어떤 주석은 필요하거나 유익하다. 하지만 정말로 좋은 주석은, 주석을 달지 않을 방법을 찾아낸 주석이다.

 

법적인 주석

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

// Copyright (C) 2003, 2004, 2005 by Object Montor, Inc. All right reserved.
// GNU General Public License 버전 2 이상을 따르는 조건으로 배포한다.

 

정보를 제공하는 주석

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

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

• 가능하다면 함수 이름에 정보를 담는 편이 더 좋다.
• 위 코드의 경우 responderBeingTested로 바꾸면 주석이 필요 없어진다.

 

 

// kk:mm:ss EEE, MMM dd, yyyy 형식이다.
Pattern timeMatcher = Pattern.compile("\\\\d*:\\\\d*\\\\d* \\\\w*, \\\\w*, \\\\d*, \\\\d*");

• 위에 제시한 주석은 코드에서 사용한 정규표현식이 시각과 날짜를 뜻한다고 설명한다.
• 시각과 날짜를 변환하는 클래스를 만들어 코드를 옮겨주면 더 좋고 더 깔끔하게 작성할 수 있다.

 

 

의도를 설명하는 주석

때때로 주석은 구현을 이해하게 도와주는 선을 넘어 결정에 깔린 의도까지 설명한다.

// 스레드를 대량 생성하는 방법으로 어떻게든 경쟁 조건을 만들려 시도한다.
for (int i = 0; i > 2500; i++) {
    WidgetBuilderThread widgetBuilderThread =
    		new WidgetBuilderThread(widgetBuilder, text, parent, failFlag);
    Thread thread = new Thread(widgetBuilderThread);
    thread.start();
}

 

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

때때로 모호한 인수나 반환값은 그 의미를 읽기 좋게 표현하면 이해하기 쉬워진다.

• 인수나 반환값이 표준 라이브러리나 변경하지 못하는 코드에 속한다면 유용하다.

public void testCompareTo() throws Exception {
    WikiPagePath a = PathParser.parse("PageA");
    WikiPagePath ab = PathParser.parse("PageA.PageB");
    WikiPagePath b = PathParser.parse("PageB");
    WikiPagePath ba = PathParser.parse("PageB.PageA");
    WikiPagePath aa = PathParser.parse("PageA.PageA");
    WikiPagePath bb = PathParser.parse("PageB.PageB");

    assertTrue(a.compareTo(a) == 0); // a == a
    assertTrue(a.compareTo(b) != 0); // a != b
    assertTrue(ab.compareTo(ab) == 0); // ab == ab
    assertTrue(a.compareTo(b) == -1); // a < b
    assertTrue(aa.compareTo(ab) == -1); // aa < ab
    assertTrue(ba.compareTo(bb) == -1); // ba < bb
    assertTrue(b.compareTo(a) == 1); // b > a
    assertTrue(ab.compareTo(aa) == 1); // ab > aa
    assertTrue(bb.compareTo(ba) == 1); // bb > ba
}

• 하지만, 그릇된 주석을 달아 놓을 위험이 상당히 높다.
• 주석이 올바른지 검증하기 쉽지 않다.
• 의미를 명료히 밝히는 주석이 필요한 이유인 동시에 위험한 이유다.

 

결과를 경고하는 주석

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

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

	response.setBody(testFile);
	response.readyToSend(this);
	String responseString = output.toString();
	assertSubString("Content-Length: 1000000000", responseString);
	assertTrue(bytesSent > 1000000000);
}

• JUnit4 라이브러리를 통해 @Ignore 속성을 이용해 테스트 케이스를 꺼버리고, 구체적인 설명은 @Ignore 속성에 문자열로 넣어줄 수 있다.
  • @Ignore(”실행이 너무 오래 걸린다.”)
• JUnit4가 나오기 이전에는 메서드 이름 앞에 _ 기호를 붙이는 방법이 관례였다.

 

TODO 주석

때로는 앞으로 할 일을 //TODO 주석으로 남겨두면 편하다.

• 함수를 구현하지 않은 이유와 미래 모습을 //TODO 주석으로 설명할 수 있다.

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

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

 

중요성을 강조하는 주석

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

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가 좋은 예다.

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

 

 

나쁜 주석

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

 

다음은 주석을 제대로 달았다면 상당히 유용했을 코드지만, 저자가 서둘렀거나 부주의한 예시이다.

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

• catch 블록에 있는 주석은 저자에게는 의미가 있겠지만, 다른 사람들에게는 전해지지 않는다.
• 해당 주석에 대한 답을 알아내려면 코드를 뒤져보는 수밖에 없다.
• 이해가 안되어 다른 모듈까지 뒤져야 하는 주석은 독자와 제대로 소통하지 못하는 주석이다.

 

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

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

// 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");
        }
    }
}

• 코드를 정당화하는 주석도 아니고, 의도나 근거를 설명하는 주석도 아니다.
• 코드보다 읽기가 쉽지도 않다.

 

다음은 톰캣(Tomcat)에서 가져온 코드다.

public abstract class ContainerBase
    implements Container, Lifecycle, Pipeline, MBeanRegistration, Serializable {

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

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

    /**
     * 이 컴포넌트를 위한 컨테이너 이벤트 Listener
     */
    protected ArrayList listeners = new ArrayList();

    /**
     * 컨테이너와 관련된 Loader rngus
     */
    protected int backgroundProcessorDelay = -1;

    ...

• 쓸모없고 중복된 Javadocs가 매우 많다.
• 해당 주석은 코드만 지저분하고 정신없게 만든다.
• 기록이라는 목적에는 전혀 기여하지 못한다.

 

오해할 여지가 있는 주석

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

위 waitForClose() 메서드의 주석은 중복이 상당히 많으면서도 오해할 여지가 있다.

this.closed가 true로 변하는 순간에 메서드는 반환되지 않는다. this.closed가 true여야 메서드는 반환된다. 아니면 무조건 타임아웃을 기다렸다 this.closed가 그래도 true가 아니면 예외를 던진다.

주석에 담긴 ‘살짝 잘못된 정보’로 인해 this.closed가 true로 변하는 순간에 함수가 반환되리라는 생각으로 함수를 호출할지도 모른다.

 

의무적으로 다는 주석

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

/**
 *
 * @param title CD 제목
 * @param author CD 저자
 * @param tracks CD 트랙 숫자
 * @param durationInMinutes CD 길이(단위: 분)
 */
public void addCD(String title, String author, int tracks, int durationInMinutes) {
    CD cd = new CD();
    cd.title = title;
    cd.author = author;
    cd.tracks = tracks;
    cd.duration = durationInMinutes;
    cdList.add(cd);
}

위와 같은 주석은 아무 가치도 없다. 오히려 코드만 헷갈리게 만들며, 거짓말할 가능성을 높이며, 잘못된 정보를 제공할 여지만 만든다.

 

이력을 기록하는 주석

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

* 변경 이력 (11-Oct-2001부터)
* 11-Oct-2001 : 클래스를 다시 정리하고 새로운 패키지인
* 		com.jrefinery.date로 옮겼다. (DG);
* 05-Nov-2001 : getDescription() 메서드를 추가했으며
* 		NotableDate class를 제거했다. (DG);
...

예전에는 모든 모듈 첫머리에 변경 이력을 기록하고 관리하는 관례가 바람직했다. 하지만 지금은 소스 코드 관리 시스템이 있기 때문에 혼란만 가중할 뿐 완전히 제거하는 편이 좋다.

 

있으나 마나 한 주석

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

/**
 * 기본 생성자
 */
protected AnnualDateRule() {
}

/** 월 중 일자 */
private int dayOfMonth;

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

• 위와 같은 주석은 지나친 참견이라 개발자가 주석을 무시하는 습관에 빠진다.
• 결국엔 코드가 바뀌면서 주석은 거짓말로 변한다.

 

private void startSending() {
    try {
        doSending();
    } catch (SocketException e) {
        // 정상. 누군가 요청을 멈췄다.
    } catch (Exception e) {
	try {
            response.add(ErrorResponder.makeExceptionString(e));
            response.closeAll();
        } catch (Exception e1) {
            // 이게 뭐야!
        }
    }
}

• 첫 번째 주석은 적절해 보인다. catch 블록을 무시해도 괜찮은 이유를 설명하는 주석이다.
• 두 번째 주석은 전혀 쓸모가 없다.

 

private void startSending() {
    try {
        doSending();
    } catch (SocketException e) {
        // 정상. 누군가 요청을 멈췄다.
    } catch (Exception e) {
        addExceptionAndCloseResponse(e);
    }
}

private void addExceptionAndCloseResponse(Exception e) {
    try {
        response.add(ErrorResponder.makeExceptionString(e));
        response.closeAll();
    } catch (Exception e1) {
    	...
    }
}

• 있으나 마나한 주석을 달려는 유혹에서 벗어나 코드를 정리하라. 더 낫고, 행복한 프로그래머가 되는 지름길이다.

 

무서운 잡음

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

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

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

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

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

• 목적 없이 단지 문서를 제공해야 한다는 잘못된 욕심으로 탄생한 잡음일 뿐이다.
• 주석을 자세히 보면, 붙여 넣기 오류가 있다. 저자가 주의를 기울이지 않았다면 독자는 무슨 이익을 얻겠는가?

 

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

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

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

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

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

 

위치를 표시하는 주석

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

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

극히 드물지만 위와 같은 배너 아래 특정 기능을 모아놓으면 유용한 경우도 있긴 하다.

하지만 일반적으로 위와 같은 주석은 가독성만 낮추므로 제거해야 마땅하다.

 

닫는 괄호에 다는 주석

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

그러므로 닫는 괄호에 주석을 달아야겠다는 생각이 든다면 대신에 함수를 줄이려 시도하자.

public class wc {
    public static void main(String[] args) {
        BufferedReader in = new BufferedReader(new InputStreamReader(System.in));
        String line;
        int lineCount = 0;
        int charCount = 0;
        int wordCount = 0;
        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.getResultStream(), formatter.getByteCount());
// InputStream resultStream = formatter.getResultStream();
// StreamReader reader = new StreamReader(resultsStream);
// response.setContent(reader.read(formatter.getByteCount()));

• 주석으로 처리된 코드는 다른 사람들이 지우기를 주저한다. 이유가 있어 남겨놓으리라고, 중요하니까 지우면 안된다고 생각한다.
• 1960년대 즈음에는 주석으로 처리한 코드가 유용했었다. 하지만 우리는 오래전부터 우수한 소스 코드 관리 시스템을 사용해 왔다.
• 소스 코드 관리 시스템이 우리를 대신해 코드를 기억해 준다. 이제는 주석으로 처리할 필요가 없다.

 

HTML 주석

소스 코드에서 HTML 주석은 혐오 그 자체다.

/**
 * 적합성 테스트를 수행하기 위한 과업
 * 이 과업은 적합성 테스트를 수행해 결과를 출력한다.
 * <p/>
 * <pre>
 * 용법:
 * &lt;taskdef nam=&quot;execute-fitness-test&quot;
 *     classname=&quot;fitnesse.ant.ExecuteFitnesseTestsTask&quot;
...

 

전역 정보

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

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

 

너무 많은 정보

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

다음은 base64를 인코딩/디코딩하는 함수를 테스트하는 모듈에서 가져온 주석이다.

/*
 RFC 2045 - Multipurpose Internet Mail Extensions (MIME)
 1부: 인터넷 메시지 본체 형식
 6.8절. Base64 내용 전송 인코딩(Content-Transfer-Encoding)
 인코딩 과정은 입력 비트 중 24비트 그룹을 인코딩된 4글자로 구성된
 출력 문자열로 표현한다. 왼쪽에서 오른쪽으로 진행해가며,
 ...
 이하 생략
 */

RFC 번호를 제외하면 독자에게 불필요하며 불가사의한 정보일 뿐이다.

 

모호한 관계

주석과 주석이 설명하는 코드는 둘 사이 관계가 명백해야 한다.

독자가 주석과 코드를 읽어보고 무슨 소린지 알아야 하지 않겠는가?

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

• 주석을 다는 목적은 코드만으로 설명이 부족해서다. 주석 자체가 다시 설명을 요구하니 안타깝기 그지없다.

 

함수 헤더

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

 

비공개 코드에서 Javadocs

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

시스템 내부에 속한 클래스와 함수에 Javadocs를 생성할 필요는 없다.

유용하지 않을 뿐만 아니라 Javadocs 주석이 요구하는 형식으로 인해 코드만 보기 실고 산만해질 뿐이다.

 

https://link.coupang.com/a/XZCz9

Clean Code 클린 코드

 

https://link.coupang.com/a/XZCEl

클린 코드+클린 아키텍처 세트

"이 포스팅은 쿠팡 파트너스 활동의 일환으로, 이에 따른 일정액의 수수료를 제공받습니다."