[클린코드] 4장. 주석

클린코드(CleanCode)를 읽고 간략하게 정리한 글입니다.

---

4장. 주석

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

- 잘 달린 주석은 유용하지만, 경솔하고 근거 없는 주석은 코드를 이해하기 어렵게 만든다.

- 오래되고 조잡한 주석은 거짓과 잘못된 정보를 퍼뜨린다.

- 코드 자체가 표현력이 풍부하다면 주석은 필요하지 않다.

- 즉, 우리는 코드로 의도를 표현하지 못해 실패를 만회하기 위해 주석을 사용하는 것이다.

- 주석은 오래될수록 코드에서 멀어진다. 오래될수록 완전히 그릇될 가능성도 있다.

- 프로그래머들이 주석을 유지 보수하긴 현실적으로 불가능하다.

- 주석을 엄격하게 관리하느니, 코드를 깔끔하게 정리하고 표현력을 강화하는 방향으로 사용해야 한다.

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

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

- 표현력이 풍부하고 깔끔하고 주석이 거의 없는 코드가, 복잡하며 어수선하고 주석이 많이 달린 코드보다 훨씬 좋다.

2. 코드로 의도를 표현하라

- 주석이 없어도 코드로 의도를 표현할 수 있다.

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

// Good
if (employee.isEligibleForFullBenefits())

3. 좋은 주석

- 좋은 주석은 종종 필요하거나 유익하다.

3-1. 법적인 주석

- 각각의 회사가 정립한 구현 표준에 맞춰 법적인 이유로 특정 주석을 넣으라고 명시하기도 한다.

- 예를 들어, 각 소스 파일 첫머리에 주석으로 들어가는 저작권 정보와 소유권 정보는 필요하다.

// Copyright (C) 2003, 2004, 2005 by Object Montor, Inc. All right reserved.
// GNU General Public License

3-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*");

- 위 코드는 정규 표현식이 시각과 날짜를 뜻한다고 설명한다.

- 이왕이면 시각과 날짜를 변환하는 클래스를 만들어 코드를 옮겨주면 더 좋고 깔끔할 것이다.

3-3. 의도를 설명하는 주석

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

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

3-4. 의미를 명료하게 밝히는 주석

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

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

3-5. 결과를 경고하는 주석

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

- 주석으로 메서드나 클래스 사용 시 주의해야 할 점을 남기거나 @Ignore 속성에 문자열로 넣어준다.

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

3-6. TODO 주석

- TODO 주석은 프로그래머가 필요하다 여기지만 당장 구현하기 어려운 업무를 기술한다.

- 요즘은 IDE를 통해 남은 TODO를 쉽게 볼 수 있어 편리하게 이용할 수 있다.

3-7. 중요성을 강조하는 주석

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

3-8. 공개 API에서 Javadocs

- 설명이 잘 된 공개 API는 참으로 유용하고 만족스럽다.

- 공개 API를 구현한다면 반드시 훌륭한 Javadocs 작성을 추천한다.

- 그렇지만 여느 주석과 마찬가지로 Javadocs 역시 그릇된 정보를 전달할 가능성이 있을 수 있다.

4. 나쁜 주석

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

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

4-1. 주절거리는 주석

- 특별한 이유 없이 달리는 주석이다.

- 아래 예시를 살펴보면, catch 블록에 있는 주석은 작성자에게야 의미가 있겠지만 다른 사람들에게는 전해지지 않는다.

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

4-2. 같은 이야기를 중복하는 주석

- 헤더에 달린 주석이 같은 코드 내용을 그대로 중복한다.

- 자칫하면 코드보다 주석을 읽는 시간이 더 오래 걸린다.

/**
 * 컨테이너와 관련된 Loader 구현
 */
 protected Loader loader = null;

4-3. 오해할 여지가 있는 주석

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

- 주석에 담긴 "살짝 잘못된 정보"로 인해 어느 프로그래머가 경솔하게 함수를 호출해 자기 코드가 아주 느려진 이유를 못 찾을 수 있다.

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

4-4. 의무적으로 다는 주석

- 모든 함수에 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);
}

4-5. 이력을 기록하는 주석

- 때때로 사람들은 모듈을 편집할 때마다 모듈 첫머리에 주석을 추가한다.

- 최근에는 소스 코드 관리 시스템(git, svn 등)이 있으니 전혀 필요가 없는 주석이다.

/*
* 변경 이력 (11-Oct-2001부터)
* ------------------------------------------------
* 11-Oct-2001 : 클래스를 다시 정리하고 새로운 패키징
* 05-Nov-2001: getDescription() 메소드 추가
* 이하 생략
*/

4-6. 있으나 마나 한 주석

- 너무나 당연한 사실을 작성, 새로운 사실이 없는 경우의 주석도 있다.

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

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

4-7. 무서운 잡음

- 때로는 javadocs도 잡음이다.

- 주석에 코드의 변수 이름을 복붙 할 생각이라면 그냥 적지 않는 편이 좋다.

- 복붙 하다 실패하면 골치만 아프다.

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

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

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

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

- 주석을 없애고 함수나 변수로 표현할 수 있다면 표현한다.

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

4-9. 위치를 표시하는 주석

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

- 특히 뒷부분이 슬래시(/)로 이어지는 잡음은 제거하는 편이 좋다.

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

4-10. 닫는 괄호에 다는 주석

- 중첩이 심하고 장황한 함수라면 의미가 있을지도 모르지만 작고 캡슐화한 함수라면 잡음일 뿐이다.

- 닫는 괄호에 주석을 달아야겠다는 생각이 든다면 대신에 함수를 줄이려는 시도를 한다.

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
}

4-11. 공로를 돌리거나 저자를 표시하는 주석

- 소스 코드 관리 시스템을 통해 누가 언제 무엇을 추가했는지 알 수 있기 때문에 저자 이름으로 코드를 오염시킬 필요가 없다.

/* Jaewon이 추가함 */

4-12. 주석으로 처리한 코드

- 초반에는 주석으로 처리한 코드가 유용했었다.

- 하지만 최근에는 소스 코드 관리 시스템이 우리를 대신해 코드를 기억해 준다.

this.bytePos = writeBytes(pngIdBytes, 0);
//hdrPos = bytePos;
writeHeader();
writeResolution();
//dataPos = bytePos;
if (writeImageData()) {
    wirteEnd();
    this.pngBytes = resizeByteArray(this.pngBytes, this.maxPos);
} else {
    this.pngBytes = null;
}
return this.pngBytes;

4-14. HTML 주석

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

- Javadocs와 같은 도구로 주석을 뽑아 웹페이지에 올릴 계획이라면 주석에 HTML 태그는 프로그래머가 아니라 도구가 책임져야만 한다.

4-15. 전역 정보

- 주석을 달아야 한다면 근처에 있는 코드만 기술해야 한다.

- 코드 일부에 주석을 달면서 시스템의 전반적인 정보를 기술하면 안 된다.

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

4-16. 너무 많은 정보

- 주석에다 흥미로운 역사나 관련 없는 정보를 장황하게 늘여놓지 말아야 한다.

4-17. 모호환 관계

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

- 주석 자체가 다시 설명을 요구하면 안 된다.

4-18. 함수 헤더

- 짧고 한 가지만 수행하며 이름을 잘 붙인 함수가 주석으로 헤더 추가한 함수보다 훨씬 좋다.

4-19. 비공개 코드에서 Javadocs

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

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

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