CleanCode

CleanCode 04 주석

,

이번에 살펴볼 파트는 주석파트입니다. 처음에 살펴볼 내용중에서 첫장부터 제게 크게 다가온 명언중 하나는

나쁜 코드에 주석을 달지 마라. 새로 짜라.

  • 브라이언 W. 커니핸,P.J 플라우거

잘 달린 주석은 그 어떤 정보보다 유용하지만, 경솔하고 근거없는 주석은 코드를 이해하기 어렵게 만든다고 합니다. 우리는 코드로 의도를 표현하지 못해, 실패를 만회하기 위해 주석을 사용한다.

주석을 무시하는 이유중 가장 무서운것은 거짓말을 한다는것이다. 오래되면 오래될 수록 그릇될 가능성이 있다.

진실은 한곳에만 존재한다. 바로 코드이다 우리는 주석을 가능한 줄이도록 해야한다.

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

코드에 주석을 추가하는 일반적인 이유는 코드 품질이 나쁘기 때문이다. 표현력이 풍부하고 깔끔하며 주석이 거의 없는 코드가, 복잡하고 어수선하며 주석이 많이 달린 코드보다 훨씬 좋다.

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

확실히 코드만으로 의도를 설명하기가 어려운 경우가 있다. 몇초만 더 생각하면 더 좋은 코드를 짤 수 있다.

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

주석으로 의도를 표현하지 말고 코드로 표현하라.

1
if (employee.isEligibleForFullBenefits())

3. 좋은 주석

정말로 좋은 주석은, 주석을 달지 않을 방법을 찾아낸 주석이라는 사실이다.

3.1. 법적인 주석

회사가 정립한 구현 표준에 맞춰 법적인 이유로 특정 주식을 넣으라고 명시한다. 각 소스 파일 첫머리에 주석으로 들어가는 저작권 정보와 소유권 정보는 필요하고도 타당하다.

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

3.2. 정보를 제공하는 주석

때로는 기본적인 정보를 주석으로 제공하면 편리하다. 예를 들면, 다음 주석은 추상 메서드가 반환할 값을 설명한다. 물론 이 또한 responderBeingTested 로 바꾸면 주석이 필요 없어진다. 이왕이면 시각과 날짜를 변환해주는 클래스를 만들어 코드를 옮겨주면 더 좋고 깔끔하겠다. 주석이 그러면 필요 없어진다.

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

3.3. 의도를 설명하는 주석

주석은 구현을 이해하게 도와주는 선을 넘어 결정에 깔린 의도까지 설명한다. 다음은 주석으로 흥미로운 결정을 기록한 예제이다. 두 객체를 비교할 때 저자는 다른 어떤 객체보다 자기 객체에 높은 순위를 주기로 결정했다.

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

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

떄때로 모호한 인수나 반환값은 그 의미를 읽기 좋게 표현하면 이해하기 쉬워진다. 일반적으로 인수나 반환값 자체를 명확하게 만들면 더 좋곗지만, 인수나 반환값이 표준 라이브러리나 변경하지 못하는 코드에 속한다면 의미는 명로하게 밝히는 주석이 용이하다

1
2
3
assertTru(a.compareTo(a) == 0); // a == a
assertTru(a.compareTo(b) == -1); // a < a
assertTru(a.compareTo(aa) == 1); // a > aa

3.5. 결과를 경고하는 주석

때로 다른 프로그래머에게 결과를 경고할 목적으로 주석을 사용한다. 경고할 목적으로 주석을 사용한다. 예를 들어, 다음은 특정 테스트 케이스를 꺼야하는 이유를 설명하는 주석이다.

1
2
// 여유 시간이 충분하지 않다면 실행하지 마십시오.
public void _testWithReallyBigFile()
1
2
3
4
5
6
7
public static simpleDateFormat makeStandardHttpDateFormat() {
  // SimpleDateFormat 은 스레드에 안전하지 못하다.
  // 그러므로 각 인스턴스를 독립적으로 생성해야 한다.
  SimpleDateFormat df = new SimpleDateFormat("EEE, dd MMM  yyyy HH:mm:ss z");
  df.setTimeZone(TimeZone.getTimeZone("GMT"));
  return df;
}

3.6. TODO 주석

앞으로 할 일은 TODO 로 남겨두면 편하다. 하지만, 너무 많아지면 좋지 않다.

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

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

1
2
3
4
5
6
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를 구현하고 싶으면 반드시 훌륭한 Javadocs를 작성한다.

3.9. 나쁜 주석

대다수의 주석이 이 범주에 속한다. 엉성한 코드를 변명하거나 허술한 코드를 지탱하려 한다.

3.10. 주절거리는 주석

주석을 달기로 결정했다면 충분한 시간을 들여 최고의 주석을 달도록 노력한다. 주석은 독자와 제대로 소통하지 못하는 주석이다. 주석은 바이트만낭비할뿐이다.
주석의 의미를 알아내려면 다른 코드를 봐야한다. 이해가 안되어 다른 모듈까지 뒤져야 하는 주석은 제대로 된 주석이 아니다.

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

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

주석이 같은 코드의 내용을 그대로 중복하면 코드보다 주석을 읽는 시간이 더 오래걸린다.

1
2
3
4
5
6
7
8
9
10
// 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.12. 오해할 여지가 있는 주석

의도는 좋았으나 프로그래머가 딱 맞을 정도로 엄밀하게는 주석을 달지 못하기도 한다. 예를 들면 위의 코드에서 this.closed 가 true 로 *변하는 순간에 반환하지 않는다. this.closed 가 true 여야 메서드를 반환한다.
즉, wait 의 타임아웃을 무조건 기다렸다가 에러를 통해 확인하게 된다. 잘못된 정보로 인해 자기코드가 굼벵이 기어가듯 돌아가는 이유를 찾느라 골머리를 앓는다.

3.13. 의무적으로 다는 주석

모든 함수에 Javadocs를 달거나 모든 변수에 주석을 달아야한다는 규칙은 어리석기 그지없다. 이런주석은 코드를 복잡하게 맏늘며, 거짓말을 퍼뜨리고, 혼동과 무질서를 초래한다. 예를 들어, 코드만 헷갈리게 만들며 거짓말할 가능성을 높이며 잘못된 정보를 제공할 여지를 만든다.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
/**
 *
 * @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);
}

3.14. 이력을 기록하는 주석

1
2
3
4
5
* 변경 이력 (11-Oct-2001부터)
* ------------------------------------------------
* 11-Oct-2001 : 클래스를 다시 정리하고 새로운 패키징
* 05-Nov-2001: getDescription() 메소드 추가
* ... 등등

해당 정보들은 소스 코드 관리시스템(Git,SVN)과 같은 것들이 해준다.

3.15. 있으나 마나 한 주석

1
2
3
4
5
/*
 * 기본 생성자
 */
protected AnnualDateRule() {
}

너무 당연한 사실은 주석으로 새로운 정보를 제공해주지 못한다. 지나친 주석을 무시하는 습관에 빠진다. 코드를 읽으며 자동으로 주석을 건너뛴다.

3.16. 무서운 잡음

1
2
/** The licenceName. */
private String licenceName;

오타가 발생하면 애매한 코드가 되어버린다.

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

​

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

주석을 없애고 다음과 같이 표현한다.

1
2
3
ArrayList moduleDependencies = smodule.getDependSubSystems();
String ourSubSystem = subSysMod.getSubSystem();
if (moduleDependees.contains(ourSubSystem))

3.18. 위치를 표시하는 주석

/로 이어지는 잡음은 제거하는 편이 좋다.

3.19. 닫는 괄호에 다는 주석

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

1
2
3
4
5
6
7
const a = () => {
  if(state) {
    while(t) {
      break;
    } //while
  } // if
}

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

1
/* kgh가 추가함 */

소스 코드 관리시스템 Github는 모든것을 기억한다.

3.20.1. 주석으로 처리한 코드

주석으로 처리한 코드만큼 밉살스러운 관행도 드물다. 다음과 같은 코드는 작성하지 말라. 과감해지자

1
2
3
4
5
6
7
8
9
10
11
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;

3.21. HTML 주석

HTML 주석은 혐오 그 자체다. Javadocs 와 같은 도구로 주석을 뽑아 웹 페이지에 올려야 한다면 주석에 HTML 태그를 삽입하는 것은 도구가 해야한다.

1
2
3
4
​<p/>
​<pre>
​용법:
블라블라~

3.22. 전역 경보

주석을 달아야 한다면 근처에 있는 코드만 기술하라. 시스템의 전반적인 형태, 정보를 담지 말아야 한다.

3.23. 너무 많은 정보

관련 없는 정보를 장황하게 늘어놓지마라!

3.24. 모호한 관계

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

3.25. 함수 헤더

짧은 함수는 긴 설명이 필요없다. 짧고 한가지만 수행하며 이름을 잘 붙인 함수가 주석으로 헤더를 추가한 함수보다 훨씬 좋다.

3.26. 비공개 코드에서 Javadocs

공개할 API 가 아니라면 쓸모가 없다. 코드만 보기싫고 산만해질 가능성이 높다.

Share