DAY 8

🔖 오늘 읽은 범위 : 4.주석(68~75p)

---

🤓 책에서 기억하고 싶은 내용

• 실패를 만회하기 위해 주석을 사용한다 → 정말 코드로 의도를 표현할 방법이 더 없나 고민
• 주석을 유지보수하는것은 불가능 → 오래될 수록 코드에서 멀어진다

  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"

  나중에 추가된 인스턴스 변수들이 주석을 원본 코드에서 멀어지게 했을듯하다
  
• 코드만이 자기가 하는 일을 진실되게 말한다.

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

• 표현력이 풍부하고 깔끔하며 주석이 거의 없는 코드가 주석많은 코드보다 훨씬 좋다
• 코드 난장판을 주석으로 덮으려 하지말고 난장판을 깨끗이 치우는 데 시간을 보내라

코드로 의도를 표현하라!

• 코드만으로 의도를 설명하기 어려운 경우도 존재

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

보다는.. 주석도 함수명으로 표현한다

if (employee.isEligibleForFullBenefits())

좋은 주석

• 그럼에도 글자값을 하는 주석들

법적인 주석

• 표준을 맞추기 위해 소스파일 첫머리에 저작권 정보와 소유권 정보

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

정보를 제공하는 주석

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

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

  그래도 왠만하면 responderBeingTested 와 같은 이름으로 설명하자
  

의도를 설명하는 주석

• 구현 이해를 넘어 결정에 깔린 의도까지 설명

  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.compareTo(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, parent, 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);
      assertTrue(a.compareTo(b) != 0);
      assertTrue(ab.compareTo(ab) == 0);
      assertTrue(a.compareTo(b) == -1);
      assertTrue(aa.compareTo(ab) == -1);
      assertTrue(ba.compareTo(bb) == -1);
      assertTrue(b.compareTo(a) == 1);
      assertTrue(ab.compareTo(aa) == 1);
      assertTrue(bb.compareTo(ba) == 1);
      // a == a // a != b // ab == ab // a < b
      // aa < ab // ba < bb // b > a // ab > aa // bb > ba
  }

결과를 경고하는 주석

• 오래걸리므로 disable 해야하는 테스트코드를 경고

// 여유 시간이 충분하지 않다면 실행하지 마십시오.
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("실행이 너무 오래 걸린다.")
...

프로그램 효율 높인다고 정적 초기화 함수를 사용할 뻔 하다가 주석을 통해 실수를 면함

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

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 를 작성 해야 함
• Javadocs 역시 독자를 오도하거나 잘못 위치하거나 그릇된 정보 전달하지않도록 주의

🤔 떠오르는 생각

• 정~말 필요한 경우가 아니라면 주석은 최대한 쓰지 말아야 겠다

🔎 질문

• 정적 초기화 함수? 인스턴스를 독립적으로 생성?

📝 소감 3줄 요약

• 인수나 반환값이 표준 라이브러리나 변경하지 못하는 코드에 속한다면 주석을 추가
• 오래걸리는 코드나 예기치 못한 결과를 주는 코드에는 경고의 주석을 추가
• TODO주석은 써도 좋지만 주기적으로 정리 하자