클린 코드 - 주석

주석은 언제나 실패를 의미한다.

오래 되고 조잡한 주석은 거짓과 잘못된 정보를 퍼뜨려 해악을 미친다. 주석은 필요악이다. 코드로 의도를 충분히 표현한다면 주석은 필요하지 않다. 따라서 주석은 의도를 표현하지 못해 실패를 만회하기 위해 사용한다.  

주석은 오래될 수록 코드에서 멀어진다. 그릇될 가능성도 커진다. 코드는 변화하고 진화하기 때문에 여기 저기로 옮겨지기도 한다. 주석은 언제나 코드를 따라가지 못한다. 

예를 들면, 

MockRequest request;
private final String HTTP_DATE_REGEXP = "[SMTWF][a-z]{2}\\,\\s[0-9]{2}\\s[JFMASOND][a-z]{2}\\s" +
      "[0-9]{4}\\s[0-9]{2}\\:[0-9]{2}\\:[0-9]}2|\\sGMT";
private Response response;
private FitNesseContext context;
private FileResponder responder;
private Locale saveLocale;
// Example: "Tue, 02 Apr 2003 22:18:49 GMT"

짐작컨대, HTTP_DATE_REGEXP 상수와 주석 사이에 다른 인스턴스 변수들이 추가되었을 가능성이 크다. 주석이 관리되는데도 에너지가 필요하므로 애초에 주석이 필요 없는 코드를 만들어야한다. 부정확한 주석보다는 아예 없는 주석이 낫다. 그러므로 우리는 주석을 가능한 줄이도록 해야한다. 

 

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

코드에 주석을 추가하는 보통의 이유는 코드 품질이 나쁘기 때문이다. 모듈을 짜고 보니 짜임새가 엉망이고 알아먹기 어렵다. 그래서 자신에게 말한다. "이런! 주석을 달아야겠다.". 아니다! 코드 정리를 해야한다. 

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

 

코드로 의도를 표현하라

확실히 코드만으로는 의도를 설명하기 어려운 경우가 존재한다. 하지만 많은 개발자들은 코드는 훌륭한 수단이 아니라는 의미로 해석한다.

어느 쪽이 더 나은가?

// 직원에게 복지 혜택을 받을 자격이 있는지 검사한다.
if ((employee.flags & HOURLY_FLAG) && 
   (employee.age > 65)) {
    ...
 }
 
 // 코드로 의도를 반영
 if (employee.isEligibleForFullBenefits())

 몇 초만 더 생각하면 코드로 대다수 의도를 표현할 수 있다. 많은 경우 주석으로 달려는 설명을 함수로 만들어 표현해도 충분하다. 

 

좋은 주석

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

법적인 주석

때로는 법적인 이유로 주석을 넣어야할 때도 있다. 예를 들어, 각 소스 파일 첫머리에 주석으로 들어가는 저작권 정보와 소유권 정보는 필요하고도 타당하다. 

// Copyright (C) 2003,2004,2005 by Object Mentor, Inc. All rights reserved.
// GNU Genera 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*")

위에서 제시한 주석은 코드에서 사용한 정규표현식이 시각과 날짜를 뜻한다고 설명한다. 구체적으로는 주어진 형식 문자열을 사용해 SimpleDateFormat.format 함수가 반환하는 시각과 날짜를 뜻한다. 이옹이면 시각과 날짜를 변환하는 클래스를 만들어주면 더 좋고 깔끔하겠다. 

• *kk - (01-24), hh - (00-23) 
• * Tuesday example : E - 2, EE - 02, EEE - Tue, EEEE - Tuesday

 

의도를 설명하는 주석

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

다음은 주석으로 흥미로운 결정을 기록한 예제이다. 두 객체를 비교할 때 다른 객체보다 자기 객체에 우선순위를 주기로 결정했다.

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.compreTo(compressedArgumentName);
  }
  return 1; // 오른쪽 유형이므로 정렬 순위가 더 높다. 
}

 

다음은 의도가 분명히 드러나는 더 나은 예제다. 

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, paremt, failFlag);
    Thread thread = new Thread(widgetBuilderThread);
    thread.start();
  }
  assertEquals(false, failFlag.get());
}

 

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

때때로 애매모호한 파라미터나 리턴값은 그 의미를 읽기 좋게 표현하면 이해가 쉬워진다. 일반적으로는 파라미터나 리턴값을 명확하게 만들면 더 좋겠지만, 아니라면 의미를 명료하게 밝히는 주석이 유용하다.

public void testCompareTo() throws Exception {
  WikiPagePath a = PathParser.parse("PageA");
  WikiPagePath ab = PathParser.parse("PageA.PageB");
  WikiPagePath b = PathParser.parse("PageB");
  WikiPagePath aa = PathParser.parse("PageA.PageA");
  WikiPagePath bb = PathParser.parse("PageB.PageB");
  WikiPagePath ba = PathParser.parse("PageB.PageA");
  
  assertTrue(a.compareTo(a) == 0); // a == a
  assertTrue(a.compareTo(b) != 0); // a != a
  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);
}

물론 요즘에는 @Ignore 속성을 이용해 테스트 케이스를 끌 수 있다. 예를 들어 @Ignore("실행이 너무 오래 걸린다.") 라고 쓸 수 있다. 다소 지저분해보일 수 있지만 적절한 알림이다.

다음은 주석이 아주 적절한 예시이다.

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

더 나은 해결책이 있다고 불평할지 모른다. 하지만 여기서는 주석이 아주 합리적이다. 스레드를 사용하려던 개발자에게 실수를 방지할 수 있다. 

 

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가 좋은 예다.  공개 API를 구현한다면 반드시 훌륭한 Javadocs를 작성해야한다. 하지만 이 장에서 설명하듯이 여느 주석과 마찬가지로 독자를 오해하도록 하거나 잘못된 정보를 전달할 가능성이 존재한다. 

 

나쁜 주석

대다수의 주석이 이 범주에 속한다. 일반적으로 대다수 주석은 허술한 코드를 지탱하거나 엉성한 코드를 변명하거나 미숙한 결정을 합리화하는 등 프로그래머가 주절거리는 독백에 지나지 않다. 

 

주절거리는 주석

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

다음은 FitNess에서 발견한 코드로 주석을 제대로 달았다면 상당히 유용했을 코드이다. 

public void loadProperties() {
  try {
    String propertiesPath = propertiesLocation + "/" + PROPERTIES_FILE;
    FileInputStream propertiesStream = new FileInputSStream(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("MockResponseSendercould not be closed");
  }
}

위와 같은 주석을 달아놓은 목적이 무엇일까? 주석이 코드보다 더 많은 정보를 제공하지 못한다. 코드의 의도나 근거를 설명하는 주석도 아니다. 

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

// ContainerBase.java
public abstract class ContainerBase implements Container, Lifecycle, Pipeline, MBeanResigtration, Serializable {
  /**
   * 이 컴포넌트의 프로세서 지연값
   */
  protected int backgroundProcessorDelay = -1;
  /**
   * 이 컴포넌트를 지원하기 위한 생명주기 이벤트 
   */
  protected LifecycleSupport lifecycle = new LifecycleSupport(this);
  /**
   * 이 컴포넌트를 위한 컨테이너 이벤트 Listener 
   */
  protected ArrayList listeners new ArrayList(); 
  /**
   * 컨테이너와 관련된 Loader 구현
   */
  protected Loader loader null; 
  /**
   * 컨테이너와 관련된 Logger 구현
   */
  protected Log logger null;   
  /**
   * 관련된 logger 이름 
   */
  protected String logName null; 
...

 

오해할 여지가 있는 주석

위에서 봤던 예제는 중복이 많으면서도 오해할 여지가 있다.

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

처음에 closed가 true면 메소드는 어떠한 처리도 하지 않는다. 두번째 closed가 true여야 메소드가 예외처리된다. 아니면 타임아웃을 기다렸다가 closed가 true여야 예외처리가 된다. 명확하지 않은 정보로 인해 어느 프로그래머가 경솔하게 함수를 호출할지도 모른다. 그래서 그 프로그래머는 이유를 찾느라 골머리를 앓는다. 

 

의무적으로 다는 주석

모든 함수에 의무적으로 Javadocs를 달거나 모든 변수에 주석을 달아야 한다는 규칙은 어리석다. 이런 주석은 코드를 복잡하게 만든다. 예를 들어 아래 주석은 아무런 가치도 없다. 

/**
 * @param title CD 제목
 * @param 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);
}

 

있으나 마나한 주석

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

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

 /** 
  * 월 일 중 날짜 
  */
 private int dayOfMonth;

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

위와 같은 주석은 개발자가 주석을 무시하는 습관을 가지게 한다. 코드를 읽을 때 자동으로 주석을 건너 뛰게 된다. 

아래 예시는 적절한 주석이다. catch 블록을 왜 무시해도 되는지 이유를 설명해준다. 하지만 두 번째 주석은 쓸모가 없다. 

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

아래와 같이 독자적인 함수로 작성하면 주석이 필요가 없다.

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) {
  }
}

 

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

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

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

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

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

 

주석으로 처리한 코드

Input5treamResponse response new Input5treamResponse();
response.setBody(formatter.getResult5tream(), formatter.getByteCount( ));
// Input5tream results5tream formatter.getResult5tream();
// 5treamReader reader new 5treamReader(results5tream);
// response.setContent(reader.read(formatter.getByteCount()));

주석으로 처리된 코드는 다른 사람이 지우기를 주저한다. 뭔가 중요하니까 지우면 안 된다고 생각하게 된다. 우리는 소스 코드 관리 시스템을 사용하고 있으므로 주석으로 처리하지 말고 지우기를 바란다.

 

전역 정보

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

아래 주석은 중복 되었다는 사실 외에도 기본 포트 정보를 기술하고 있다. 함수 자체는 포트 기본값을 전혀 통제하지 못한다. 아래 주석은 아래 함수가 아니라 시스템 어딘가 있는 다른 함수를 설명하다는 말이다. 

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

 

모호한 관계

주석과 코드의 사이는 명백해야한다. 아래는 아파치 commons에서 가져온 주석이다.

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

여기서 필터 바이트란 무엇일까? + 1과 관계가 있을까? 아니면 *3과 관련이 있을까? 한 픽셀이 바이트인가? 여기서 200을 추가하는 이유는? 코드만으로는 설명이 부족하다. 

 

비공개 코드에서 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 5 maxValue + 1; // 배열 크기
      boolean[] f = new boolean[s];
      int i;
      
      // 배열을 참으로 초기화
      for (i = 0; i < 5; i++)
        f[i] true;

      // 소수가 아닌 알려진 숫자들 제거
      f[0] = f[1] = 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[i]) // 소수일 경우에
           primes[j++] = i;
        }
        
       return primes; / / 소수를 반환한다.
    } else { // maxValue < 2
      return new int[0]; // 입력이 잘못 되면 비어 있는 배열을 반환한다. 
    }
}

 

아래는 위 코드를 리팩토링한 결과다. 주석 양이 상당히 줄었다는 사실에 주목한다. 주석은 두 개 뿐이다. 

 /*
  * 이 클래스는 사용자가 지정한 최대값까지 소수를 구한다.
  * 알고리즘은 에라스토테네스의 체다.
  * 에서 시작하는 정수 배열을 대상으로 작업한다.
  * 처음으로 남아있는 정수를 찾아 배수를 모두 제거한다.
  * 배열에 더 이상 배수가 없을 때까지 반복한다.
  */
public class PrimeGenerator {
  private static boolean[] crossedOut;
  private static int[] result;

  public static int[] generatePrimes(int maxValue) {
    if (maxValue < 2)
      return new int[O]; 
    else {
      uncrossintegersUpto(maxValue);
      crossoutMultiples();
      putUncrossedIntegersintoResult();
      return result;
    }
  }
  
  private static void uncrosslntegersUpTo(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 determinelterationLimit() {
    // 배열에 있는 모든 배수는 배열 크기의 제곱근보다 작은 소수의 인수다.
    // 따라서 이 제곱근보다 더 큰 숫자의 배수는 제거할 필요가 없다.
    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;
  }
}

첫 번째 주석은 generatePrimes 함수와 중복이라고 생각하기 쉽지만, 이 주석으로 알고리즘의 이해가 쉽기 때문에 남겨뒀다. 

두 번째 주석은 루프 한계 값으로 제곱근을 사용한 이유를 설명한다. 확실히 필요하다.

 

결론 

나쁜 주석 

• 주절거리는 주석
• 같은 이야기를 중복하는 주석
• 오해할 여지가 있는 주석
• 의무적으로 다는 주석
• 있으나 마나한 주석
• 주석으로 처리한 코드
• 전역 정보
• 모호한 관계

좋은 주석 

• 주석은 코드를 해석하는 것은 개발자의 몫이고, 왜? 이렇게 결정했는지에 대한 의도를 설명해야한다.