4장, 주석

2022.03.13

잘 달린 주석은 그 어떤 정보보다 유용하다. 경솔하고 근거 없는 주석은 코드를 이해하기 어렵게 만든다.
오래되고 조잡한 주석은 거짓과 잘못된 정보를 퍼트려 해악을 미친다.

우리는 코드로 의도를 표현하지 못해(실패를 만회하기 위해) 주석을 사용한다.
주석은 오래될수록 코드에서 멀어진다. 주석을 유지하고 보수하기란 현실적으로 불가능하다.

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

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

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

표현력이 풍부하고 깔끔하며 주석이 거의 없는 코드가, 복잡하고 어수선하며 주석이 많이 달린 코드보다 훨씬 좋다.
자신이 저지른 난장판을 주석으로 설명하려 애쓰는 대신에 그 난장판을 깨끗이 치우는데 시간을 보내라!

코드로 의도를 표현하라!

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

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

좋은 주석

법적인 주석

때로는 회사가 정립한 구현 표준에 맞춰 법적인 이유로 특정 주석을 넣으라고 명시한다.
예를 들어, 저작권 정보와 소유권 정보 등이 들어갈 수 있다.

정보를 제공하는 주석

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

위에서 제시한 주석은 코드에서 사용한 정규표현식에 대해 설명한다.
이왕이면 시각과 날짜를 변환하는 클래스를 만들어 코드를 옮겨주면 더 좋고 더 깔끔하다. ( 그러면 주석도 필요 없어진다. )

의도를 설명하는 주석

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

때로는 주석으로 구현 이해를 도와주는 걸 넘어서 결정에 깔린 의도까지 설명하기도 한다.

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

1public void testCompareTo() throws Exception {
2    WikiPagePath a = PathParser.parse("PageA");
3    WikiPagePath ab = PathParser.parse("PageA.PageB");
4    WikiPagePath b = PathParser.parse("PageB");
5
6    assertTrue(a.compareTo(a) == 0);    // a == a
7    asserTrue(a.compareTo(b) != 0);     // a != b
8    assertTrue(ab.compareTo(ab) == 0);  // ab == ab
9}

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

TODO 주석

TODO 주석은 프로그래머가 필요하다 여기지만 당장 구현하기 어려운 업무를 기술한다.
하지만 어떤 용도로 사용하든 시스템에 나쁜 코드를 남겨 놓는 핑계가 되어서는 안 된다.

중요성을 강조하는 주석

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

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

나쁜 주석

주절거리는 주석

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

주석으로 주절거리는 부분은 작성한 개발자에게야 의미가 있겠지만, 다른 사람에게는 전달되지 않는다. 이해하기도 쉽지 않고, 결국 답을 알아내려면 다른 코드까지 뒤져봐야 한다.

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

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

주석이 코드보다 더 많은 정보를 제공하지 못한다. 코드를 정당화하는 주석도 아니고, 의도나 근거를 설명하는 주석도 아니다.

의무적으로 다는 주석

1/**
2 *
3 * @param title CD 제목
4 * @param author CD 저자
5 */
6public void addCD(String title, String author) {
7    CD cd = new CD();
8    cd.title = title;
9    cd.author = author;
10    cdList.add(cd);
11}

모든 함수에 Javadocs를 달거나, 모든 변수에 주석을 달아야 한다는 규칙을 효율적이지 않다. 오히려 코드를 복잡하게 만들며, 그릇된 정보를 퍼뜨리고, 혼동과 무질서를 초래한다.

있으나 마나 한 주석

1/**
2 * 기본 생성자
3 */
4protected AnnualDateRule() {
5}

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

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

1// 전역 목록 <smodule>에 속하는 모듈이 우리가 속한 하위 시스템에 의존하는가?
2if (smodule.getDependSubsystems().contains(subSysMod.getSubSystem()))
1ArrayList moduleDependees = smodule.getDependSubsystems();
2String ourSubSystem = subSysMod.getSubSystem();
3if (moduleDependees.contains(ourSubSystem))

위와 같이 주석이 필요하지 않도록 코드를 개선하자.

주석으로 처리한 코드

1InputStreamResponse response = new InputStreamResponse();
2response.setBody(formatter.getResultStream(), formatter.getByteCount());
3// InputStream resultsStream = formatter.getResultStream();
4// StreamReader reader = new StreamRead(resultsStream);
5// response.setContent(reader.read(formatter.getByteCount()));

주석으로 처리한 코드는 절대 작성하면 안 된다.
이러한 코드는 혹여나 하는 마음에 다른 사람들이 지우기를 주저하고, 그래서 쓸모 없는 코드가 점차 쌓여 간다.

전역 정보를 나타내는 주석

1/**
2 * 적합성 테스트가 동작하는 포트: 기본값은 <b>8082</b>.
3 *
4 * @param fitnessePort
5 */
6public void setFitnessePort(int fitnessePort) {
7    this.fitnessePort = fitnessePort;
8}

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