[Clean Code] 4장 주석

Intro

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

• 주석은 기껏해야 필요악이다.
• 주석은 언제나 실패를 의미한다. 주석 없이는 표현 방법을 찾지 못해 주석을 사용한다. 그래서 주석은 반겨 맞을 손님이 아니다.
• 주석이 오래될수록 코드에서 멀어져서 거짓말을 하게 될 가능성이 커지기 때문이다.
• 주석을 가능한 줄이도록 꾸준히 노력해야 한다.

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

• 코드에 주석을 추가하는 일반적인 이유는 코드 품질이 나빠서이다.
• 깔끔하고 주석이 거의 없는 코드가, 복잡하고 어수선하며 주석이 많이 달린 코드보다 훨씬 좋다.
• 주석으로 설명하려 애쓰는 대신에 그 난장판을 깨끗이 치우는 데 시간을 보내라!

코드로 의도를 표현하라

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

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

// Good
if (employee.isEligibleForFullBenefits())

좋은 주석

법적인 주석

• 각 소스 파일 첫머리에 들어가는 저작권 정보와 소유권 정보 등
• 예시1

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

정보를 제공하는 주석

• 때로는 기본적인 정보를 제공하면 편리하다.
• 예시 1, 물론 이 주석도 함수 이름에 정보를 담아 responderBeingTested로 바꾸면 없앨 수 있다.

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

• 예시 2, 좀 더 나은 예
• 이왕이면 시각과 날짜를 변환하는 클래스를 만들어 코드를 옮기면 더 좋고 더 깔끔하다.

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

의미를 설명하는 주석

• 때론 주석은 결정에 깔린 의도까지 설명한다.
• 예시 1

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

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

• 때때로 모호한 인수나 반환값은 그 의미를 읽기 좋게 표현하면 이해하기 쉬워진다.
• 인수나 반환값이 표준 라이브러리나 변경하지 못하는 코드에 속할때 유용하다.

결과를 경고하는 주석

• 예시 1, JUnit 의 경우 @Ignore, @Disabled 사용

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

TODO 주석

• TODO 주석은 프로그래머가 필요하다 여기지만 당장 구현하기 어려운 업무를 기술한다.
• 요즘은 IDE를 통해 남은 TODO를 쉽게 볼 수 있으므로 편리하게 이용할 수 있다.
• 예시1

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

중요성을 강조하는 주석

• 예시 1

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

공개 API에서 Javadocs

• 설명이 잘 된 공개 API는 참으로 유용하고 만족스럽다.
• 공개 API를 구현한다면 반드시 훌륭한 Javadocs 작성을 추천한다.
• 여느 주석과 마찬가지로 Javadocs 역시 그릇된 정보를 전달할 가능성 있을수 있다.

나쁜 주석

• 대다수의 주석이 이 범주에 속한다.
• 일반적으로 대다수 주석은 프로그래머의 부족함을 나타낸다.

주절거리는 주석

• 특별한 이유 없이 달리는 주석이다.
• 예시 1, catch 블록에 있는 주석은 저자에게야 의미가 있겠지만 다른 사람들에게는 전해지지 않는다.

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

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

• 같은 이야기를 중복하며 주석이 코드보다 더 많은 정보를 제공하지 못하면 좋지 않다.

오해할 여지가 있는 주석

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

의무적으로 다는 주석

• 모든 함수에 Javadocs를 달거나 모든 변수에 주석을 달아야 한다는 규칙은 어리석기 그지없다.
• 이런 주석은 코드를 복잡하게 만들며, 거짓말을 퍼뜨리고, 혼동과 무질서를 초래한다.
• 예시 1, 모든 함수에 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);
}

이력을 기록하는 주석

• 지금은 소스 코드 관리 시스템이 있으니 전혀 필요없다.
• 예시 1

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

있으나 마나 한 주석

• 너무나 당연한 사실 언급, 새로운 사실이 없는 경우
• 예시 1

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

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

무서운 잡음

• 때로는 javadocs도 잡음이다.
• 아래와 같이 무조건 문서를 제공해야 한다는 잘못된 욕심으로 탄생한 잡음이다.
• 예시1, 어느 잘 알려진 오픈 소스 라이브러리... 심지어 복사 붙혀넣기 오류도 보인다.

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

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

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

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

• 예시 1

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

위치를 표시하는 주석

• 때때로 프로그래머는 소스 파일에서 특정 위치를 표시하려 주석을 사용한다.
• 특히 뒷부분이 슬래시(/)로 이어지는 잡음은 제거하는 편이 좋다.
• 반드시 필요하다면 아주 드물게 사용하는 편이 좋다.
• 예시 1

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

닫는 괄호에 다는 주석

• 중첩이 심하고 장황한 함수라면 의미가 있을지도 모르지만 작고 캡슐화면 함수에는 잡음일 뿐이다.
• 닫는 괄호에 주석을 달아야겠다는 생각이 든다면 대신에 함수를 줄이려 시도하자.

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

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

/* 릭이 추가함 */

주석으로 처리한 코드

• 1960년대 즈음에는 주석으로 처리한 코드가 유용했었다.
• 우리는 우수한 소스 코드 관리 시스템이 우리를 대신해 코드를 기억해준다.
• 그냥 삭제하라. 잃어버릴 염려는 없다. 약속한다.
• 예시 1

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;

HTML주석

• 소스 코드에 HTML 주석은 혐오 그 자체이다.
• javadocs 와 같은 도구로 주석을 뽑아 웹페이지에 올릴 계획이라면 주석에 HTML 태그는 프로그래머가 아니라 도구가 책임져야한다.

전역 정보

• 주석을 달아야 한다면 근처에 있는 코드만 기술하라.
• 시스템의 전반적인 정보를 기술하지 마라.
• 해당 시스템의 코드가 변해도 주석이 변하리라는 보장은 전혀 없다.
• 예시 1, 함수 자체가 기본 포트값을 전혀 통제하지 못한다.

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

너무 많은 정보

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

모호한 관계

• 주석과 주석이 설명하는 코드는 둘 사이 관계가 명백해야한다.
• 주석 자체가 다시 설명을 요구하면 안된다.

함수 헤더

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

비공개 코드에서 Javadocs

• 공개하지 않을 코드라면 Javadocs는 쓸모 없음!
• 시스템 내부에 속한 클래스와 함수에 javadocs를 생성할 필요는 없다.