[Clean Code] Chapter 4 주석

해당 포스팅 내용은 책 'Clean Code - Robert C. Martin' 출처로 합니다.

 

 

 

---

 

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

우리는 코드로 의도를 표현하지 못해, 그러니까 실패를 만회하기 위해 주석을 사용한다.

 

부정확한 주석은 아예 없는 주석보다 훨씬 더 나쁘기 때문에, 코드를 깔끔하게 정리하고 표현력을 강화하는 방향으로 그래서 애초에 주석이 필요 없는 방향으로 코드를 작성해야 한다.

 

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

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

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

 

코드로 의도를 표현하라

확실히 코드만으로 의도를 설명하기 어려운 경우가 존재한다.

 

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

 

하지만, 몇 초만 더 생각하면 코드로 대다수 의도를 표현할 수 있다.

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

 

if (employee.isEligibleForFullBenefits())

 

좋은 주석

어떤 주석은 필요하거나 유익하다.

하지만 정말로 좋은 주석은, 주석을 달지 않을 방법을 찾아낸 주석이라는 사실을 명심하기 바란다.

 

 

1. 법적인 주석

때로는 회사가 정립한 구현 표준에 맞춰 법적인 이유로 특정 주석을 넣으라고 명시한다.

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

→ 소스 파일 첫머리에 들어가는 주석이 반드시 계약 조건이나 법적인 정보일 필요는 없다.

 

 

2. 정보를 제공하는 주석

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

예를 들어, 다음 주석은 추상 메서드가 반환할 값을 설명한다.

 

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

 

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

예를 들어, 위 코드는 함수 이름을 responderBeingTested로 바꾸면 주석이 필요 없어진다.

 

 

3. 의도를 설명하는 주석

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

 

public void testConcurrentAddWidgets() throws Exception { 
    WidgetBuilder widgetBuilder = new WidgetBuilder(new Class[]{BoldWidget. class});
    String text = "'''bold text'''";
    ParentWidget parent = new BoldWidget(new MockWidgetRoot(), "'''bold text'''";
    AtomicBoolean failFlag = new AtomicBoolean();
    failFlag.set(false);
    
    // 스레드를 대량 생성하는 방법으로 어떻게든 경쟁 조건을 만들려 시도한다.
    for (int i = 0; i < 25000; i++) { 
    	WidgetBuilderThread widgetBuilderThread =
			new WidgetBuilderThread(widgetBuilder, text, parent, failFlag);
        Thread thread = new Thread(widgetBuilderThread);
        thread.start();
    }
    assertEquals(false, failFlag.get());
}

 

 

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

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

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

 

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

 

물론 그릇된 주석을 달아놓을 위험은 상당히 높고, 주석이 올바른지 검증하기 쉽지 않다.

이것이 의미를 명료히 밝히는 주석이 필요한 이유인 동시에 주석이 위험한 이유이기도 하다.

 

 

5. 결과를 경고하는 주석

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

예를 들어, 특정 테스트 케이스를 꺼야 하는 이유를 설명하는 주석이다.

 

물론 요즘에는 @Ignore 속성을 이용해 테스트 케이스를 꺼버린다.

구체적인 설명은 @Ignore 속성에 문자열로 넣어, @Ignore("실행이 너무 오래 걸린다.")라고 쓴다.

 

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

 

더 나은 해결책이 있을지 모르지만, 여기서는 주석이 아주 합리적이다.

프로그램 효율을 높이기 위해 정적 초기화 함수를 사용하려던 열성적인 프로그래머가 주석 때문에 실수를 면한다.

 

 

6. TODO 주석

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

 

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

 

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

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

 

요즘 대다수 IDE는 TODO 주석을 전부 찾아주는 기능을 제공해 주석을 잊어버릴 염려는 없다.

그래도 주기적으로 TODO 주석을 점검해 없애도 괜찮은 주석은 없애라고 권한다.

 

 

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

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

 

 

8. 공개 API에서 Javadocs

설명이 잘 된 공개 API는 유용하며, 표준 자바 라이브러리에서 사용한 Javadocs가 좋은 예다.

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

 

나쁜 주석

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

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

 

 

1. 주절거리는 주석

특별한 이유 없이 의무감으로 혹은 프로세스에서 하라고 하니까 마지못해 주석을 단다면 전적으로 시간낭비다.

 

저자가 작성한 주석이 다른 사람들에게 전해지지 않는 경우, 답을 알아내려면 다른 코드를 찾아보는 수밖에 없다.

이해가 안 되어 다른 모듈까지 뒤져야 하는 주석은 독자와 제대로 소통하지 못하는 주석이다. 그런 주석은 바이트만 낭비할 뿐이다.

 

 

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

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

자칫하면 코드보다 주석을 읽는 시간이 더 오래 걸린다. 또한 주석이 코드보다 더 많은 정보를 제공하지 못한다. 코드를 정당화하는 주석도 아니고, 의도나 근거를 설명하는 주석도 아니다. 실제로 코드보다 부정확해 독자가 함수를 대충 이해하고 넘어가게 만든다.

 

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

 

 

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

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

 

위의 코드에서 봤던 주석을 떠올려보자. 해당 주석은 중복이 많으면서도 오해할 여지가 있다.

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

 

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

 

 

4. 의무적으로 다는 주석

모든 함수에 Javadocs를 달거나 모든 변수에 주석을 달아야 한다는 규칙은 어디석기 그지없다.

이런 주석은 코드를 복잡하게 만들며, 거짓말을 퍼뜨리고, 혼동과 무질서를 초래한다.

 

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

 

 

5. 이력을 기록하는 주석

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

그리하여 모듈 첫머리 주석은 지금까지 모듈에 가한 변경을 모두 기록하는 일종의 일지 혹은 로그가 된다.

 

예전에는 소스 코드 관리 시스템이 없었기 때문에 바람직했지만, 이제는 혼란만 가중할 뿐이다.

완전히 제거하는 편이 좋다.

 

 

6. 있으나 마나 한 주석

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

 

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

 

위와 같은 주석은 지나친 참견이라 개발자가 주석을 무시하는 습관에 빠지게 한다.

 

 

7. 무서운 잡음

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

아래 나오는 Javadocs는 어떤 목적을 수행하는 것이 아닌, 단지 문서를 제공해야 한다는 잘못된 욕싱므로 탄생한 잡음일 뿐이다.

 

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

 

 

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

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

 

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

 

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

 

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

 

 

9. 위치를 표시하는 주석

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

예를 덜어, 다음과 같은 행이다.

 

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

 

너무 자주 사용하지 않는다면, 위와 같은 배너 아래 특정 기능을 모아놓으면 유용한 경우도 있긴 있다.

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

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

 

 

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.lengthO;
            String words[] = line.split("\\W");
            wordCount += words.length;
    	} //while
        System.out.printIn("wordCount = " + wordCount);
        System.out. printIn("HneCount = " + lineCount);
        System.out. printIn("charCount = " + charCount);
    } //try
    catch (lOException e) {
    	System.err. printIn("Error:" + e.getMessage());
    } //catch
} //main
}

 

 

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

저자와 같은 정보는 소스 코드 관리 시스템에 저장하는 편이 좋다.

 

주석이 있으면 다른 사람들이 코드에 관해 누구한테 물어볼지 아니까 주석이 유용하다 여길지도 모르겠지만,

현실적으로 이런 주석은 오랫동안 코드에 방치되어 점차 부정확하고 쓸모없는 정보로 변하기 쉽다.

 

 

12. 주석으로 처리한 코드

주석으로 처리된 코드는 이유가 있어 남겨놓았으리라고, 중요하니까 다른 사람들이 지우면 안 된다고 생각한다.

그래서 앙금이 쌓이듯 쓸모 없는 코드가 점차 쌓여간다.

 

InputStreamResponse response = new InputStreamResponse();
response.setBody(formatter.getResultStream(), fomatter.getByteCo니nt());
// Inputstream resultsStream = formatter.getResultStream();
// StreamReader reader = new StreamReader(resultsStream);
// response.setContent(reader.read(formatter.getByteCount()));

 

1960년대 즈음에는 주석으로 처리한 코드가 유용했었다.

하지만 우리는 오래전부터 소스 코드 관리 시스템을 사용해왔다.

소스 코드 관리 시스템이 코드를 기억해주기 때문에 이제는 주석으로 처리할 필요가 없다. 그냥 삭제하라!

 

 

13. HTML 주석

HTML 주석은 주석을 읽기 쉬워야 하는 편집기/IDE에서조차 읽기 어렵다.

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

 

/**
 * 적합성 테스트를 수행하기 위한 과업
 * 이 과업은 적합성 테스트를 수행해 결과를 출력한다.
 * <p/>
 * <pre>
 * 용법:
 * &lt;taskdef name=&quot;execute-fitnesse-tests&quot;
 * classname=&quot;fitnesse.ant.ExecuteFitnesseTestsTask&quot;
 * classpathref=&quot;classpath&quot; /&gt;
 * 또는
 * &lt;taskdef classpath ref=&quot;classpath&quot;
 * resource=&quot;tasks.properties&quot; /&gt;
 * <p/>
 * &lt;execute-fitnesse-tests
 * 	suitepage=&quot;FitNesse.SuiteAcceptanceTests&quot;
 * 	fitnesseport=&quot;8082&quot;
 * 	resultsdir=&quot;${results•dir}&quot;
 * 	resultshtmlpage=&quot;fit-results.html&quot;
 * 	classpathref=&quot;classpath&quot; /&gt;
 * </pre>
 */

 

 

14. 전역 정보

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

코드 일부에 주석을 달면서 시스템의 전반적인 정보를 기술하지 마라.

 

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

 

위 코드는 심하게 중복되었다는 사실 외에도 주석은 기본 포트 정보를 기술한다.

하지만 함수 자체는 포트 기본값을 전혀 통제하지 못한다.

해당 주석은 아래 함수가 아니라 시스템 어딘가에 있는 다른 함수를 설명하는 주석이다.

→ 포트 기본값을 설정하는 코드가 변해로 아래 주석이 변하리라는 보장이 전혀 없다.

 

 

15. 너무 많은 정보

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

 

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

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

 

/*
 RFC 2045 — Multipurpose Internet Mail Extensions (MIME)
 1부: 인터넷 메시지 본체 형식
 6.8절. Base64 내용 전송 인코딩(Content-Transfer-Encoding)
 인코딩 과정은 입력 비트 중 24비트 그룹을 인코딩된 4글자로 구성된
 출력 문자열로 표현한다. 왼쪽에서 오른쪽으로 진행해가며, 3개를 묶어 8비트 입력
 그룹을 형성한다. 이렇게 만들어진 24비트는 4개를 묶어 6비트 그룹으로 취급하며,
 각각은 base64 알파벳에서 단일 자릿수로 해석된다.
 base64 인코딩으로 비트 스트림을 인코딩할 때, 비트 스트림은
 MSB(Most Significant Bit) 우선으로 정렬되어 있다고 가정한다. 따라서, 스트림에서
 첫 번째 비트는 첫 8비트 바이트에서 최상위 비트가 되며, 여덟번째 비트는 첫 8비트
 바이트에서 최하위 비트가 된다.
*/

 

 

16. 모호한 관계

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

주석을 다는 목적은 코드만으로 설명이 부족해서다. 주석 자체가 다시 설명을 요구해서는 안된다.

 

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

 

여기서 필터 바이트란 무엇일까?

 

 

17. 함수 헤더

짧은 함수는 긴 설명이 필요 없다.

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

 

 

18. 비공개 코드에서 Javadocs

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

 

/**
 * 이 클래스는 사용자가 지정한 최대 값까지 소수를 생성한다. 사용된 알고리즘은
 * 에라스토테네스의 체다.
 * <p>
 * 에라스토테네스: 기원전 276년에 리비아 키레네에서 출생, 기원전 194년에 사망
 * 지구 둘레를 최초로 계산한 사람이자 달력에 윤년을 도입한 사람.
 * 알렉산드리아 도서관장을 역임.
 * <p>
 * 알고리즘은 상당히 단순하다. 2에서 시작하는 정수 배열을 대상으로
 * 2의 배수를 모두 제거한다. 다음으로 남은 정수를 찾아 이 정수의 배수를 모두 지운다.
 * 최대 값의 제곱근이 될 때까지 이를 반복한다.
 *
 * @author Alphonse
 * @version 13 Feb 2002 atp
 */
import java.util.*;

public class GeneratePrimes {
 /**
  * @param maxValue는 소수를 찾아낼 최대 값
  */
  public static int[] generatePrimes(int maxValue) {
    if (maxValue >= 2) // 유일하게 유효한 경우
    {
      // 선언
      int s = maxValue + 1; // 배열 크기
      boolean[] f = new boolean[s];
      int i;
      
      // 배열을 참으로 초기화
      for (i = 0; i < s; i++)
        f[i] = true;
      // 소수가 아닌 알려진 숫자를 제거
      f[0] = f[l] = false;
      
      // 체
      int j;
      for (i = 2; i < Math.sqrt(s) + 1; i++) {
        if (f[i]) // i가 남아 있는 숫자라면 이 숫자의 배수를 구한다.
        {
          for (j = 2 * i; j < s; j += i)
            f[j] = false; // 배수는 소수가 아니다.
         }
       }
       
       // 소수 개수는?
       int count = 0;
       for (i = 0; i < s; i++) {
         if (f[i])
           count++; // 카운트 증가
       }
       
       int[] primes = new int[count];
       
       // 소수를 결과 배열로 이동한다.
       for (i = 0, j = 0; i < s; i++) {
         if (f[il) // 소수일 경우에
           primes[j++] = i;
       }
       
       return primes; // 소수를 반환한다.
     } else // maxValue < 2
         return new int[0]; // 입력이 잘못되면 비어 있는 배열을 반환한다.
  }
}

 

위 코드 리팩토링 후 ↓

 

/**
 * 이 클래스는 사용자가 지정한 최대 값까지 소수를 구한다.
 * 알고리즘은 에라스토테네스의 체다.
 * 2에서 시작하는 정수 배열을 대상으로 작업한다.
 * 처음으로 남아 있는 정수를 찾아 배수를 모두 제거한다.
 * 배열에 더 이상 배수가 없을 때까지 반복한다.
 */
 
public class PrimeGenerator {
  private static boolean[] crossedOut;
  private static int[] result;
  
  public static int[] generatePrimes(int maxValue)
  {
    if (maxValue < 2)
      return new int[0];
    else {
      uncrossIntegersUpTo(maxValue);
      crossOutMultiples();
      putUncrossedIntegersIntoResult();
      return result;
    }
  }
  
  private static void uncrossIntegersUpTo(int maxValue) {
    crossedOut = new boolean[maxValue + 1];
    for (int i = 2; i < crossedOut.length; i++)
      crossedOut[i] = false;
  }
  
  private static void crossOutMultiples() {
    int limit = determineIterationLimit();
    for (int i = 2; i <= limit; i++)
      if (notCrossed(i))
        crossOutMultiplesOf(i);
  }
  
  private static int detemineIterationLimit() {
    // 배열에 있는 모든 배수는 배열 크기의 제곱근보다 작은 소수의 인수다.
    // 따라서 이 제곱근보다 더 큰 숫자의 배수는 제거할 필요가 없다.
    double iterationLimit = Math.sqrt(crossedOut.length);
    return (int) iterationLimit;
  }
  
  private static void crossOutMultiplesOf(int i) {
    for (int multiple = 2*i;
         multiple < crossedOut.length;
         multiple += i;
      crossedOut[multiple] = true;
  }
  
  private static boolean notCrossed(int i) {
    return crossedOut[i] = false;
  }
  
  private static void putUncrossedIntegersIntoResult() {
    result = new int[numberOfUncrossedIntegers()];
    for (int j =0, i = 2; i < crossedOut.length; i++)
    if (notCrossed(i))
      result[j++] = i;
  }

  private static int numberOfUncrossedIntegers() {
    int count = 0;
    for (int i = 2; i < crossedOut.length; i++)
      if (notCrossed(i))
        count++;
    return count;
  }
}

 

---

이상 돌에였습니다😶😵‍💫🎵🎶