Clean Code] 4장: 주석

로버트 마틴의 클린 코드 4장 주석 정리

 

 

4장 주석

 

▷ 서론

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

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

코드는 변화하고 진화하지만, 주석은 이를 따라가지 못한다.

 

필자의 경우 주석을 체계적으로 관리하는 대신 코드를 깔끔하고 표현력을 강화하는 방향으로, 그래서 애초에 주석이 필요 없는 방향으로 에너지를 쏟겠다고 함.

 

 

 

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

코드에 주석을 추가하는 일반적인 이유는 코드 품질이 나쁘기 때문이다. 표현력이 풍부하고 깔끔하며 주석이 거의 없는 코드가, 복잡하고 어수선하며 주석이 많이 달린 코드보다 훨씬 좋다. 자신이 저지른 난장판을 주석으로 설명하려 애쓰는 대신에 그 난장판을 깨끗이 지우는 데 시간을 보내라!

 

 

 

▷ 코드로 의도를 표현하라!

다음 코드 예제 두 개를 살펴보자. 어느 쪽이 더 나은가?

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

if (employee.isEligibleFourFullBenefits())

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

 

이 부분은 예전에 설명한 '추상화 레벨'과 관련이 있는 것 같다.

https://onlyfor-me-blog.tistory.com/617

 

 

 

 

▷ 좋은 주석

어떤 주석은 필요하거나 유익하다. 지금부터 글자 값을 한다고 생각하는 주석 몇 가지를 소개한다.

 

법적인 주석

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

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

 

 

정보를 제공하는 주석

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

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

위에 제시한 주석은 코드에서 사용한 정규표현식이 시각과 날짜를 뜻한다고 설명한다. 이왕이면 시각과 날짜를 변환하는 클래스를 만들어 코드를 옮겨주면 더 좋고 깔끔하겠다. 그러면 주석이 필요 없어진다.

 

의도를 설명하는 주석

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

아래 코드는 저자의 의도가 분명하게 드러난다.

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

 

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

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

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

물론 그릇된 주석을 달아놓을 위험은 상당히 높다. 직전 예제를 살펴보면 알겠지만, 주석이 올바른지 검증하기 쉽지 않다. 이것이 의미를 명료히 밝히는 주석이 필요한 이유인 동시에 주석이 위험한 이유이기도 하다.

 

 

결과를 경고하는 주석

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

// SimpleFormat은 스레드에 안전하지 못하다.
// 따라서 각 인스턴스를 독립적으로 생성해야 한다.
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 주석은 프로그래머가 필요하다 여기지만 당장 구현하기 어려운 업무를 기술한다. 더 이상 필요 없는 기능을 삭제하라는 알림, 누군가에게 문제를 봐달라는 요청, 더 좋은 이름을 떠올려달라는 부탁, 앞으로 발생할 이벤트에 맞춰 코드를 고치라는 주의 등에 유용하다.

하지만 어떤 용도로 사용하든 시스템에 나쁜 코드를 남겨 놓는 핑계가 되어서는 안 된다.

 

요즘 나오는 IDE는 TODO 주석 전부를 찾아 보여주는 기능을 제공하므로, 주기적으로 TODO 주석을 점검해 없애도 괜찮은 주석은 없애라.

 

 

중요성을 강조하는 주석

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

String listItemContent = match.group(3).trim();
// 여기서 trim은 정말 중요하다. trim 함수는 문자열에서 시작 공백을 제거한다.
// 문자열에서 시작 공백이 있으면 다른 문자열로 인식하기 떄문이다.

 

 

공개 API에서 Javadocs

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

 

 

 

▷ 나쁜 주석

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

 

주절거리는 주석

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

public void loadProperties() {
	try {
	    ...
    }
    catch(IOException e) {
    	// 속성 파일이 없다면 기본값을 모두 메모리로 읽어 들였다는 의미다.
    }

catch에 어떤 작업을 하려고 주석을 달아 놓은 것인가? 아니면 나중에 작업을 하려고 써놓은 주석인가?

확실하지 않기 때문에 로직을 까볼 수 밖에 없다.

 

이해가 되지 않고 개발자 자신만 아는 말로 써놓는 건 최악이다.

 

 

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

아래 예시는 간단한 함수로, 헤더에 달린 주석이 같은 코드 내용을 그대로 중복한다. 자칫하면 코드보다 주석을 읽는 시간이 더 오래 걸린다.

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

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

또한 코드보다 정확하지도 않는다.

 

 

오해할 여지가 있는 주석

때때로 의도는 좋았으나 프로그래머가 딱 맞을 정도로 엄밀하게는 주석을 달지 못하기도 한다. (코드보다 읽기도 어려운) 주석에 담긴 '살짝 잘못된 정보'로 인해 어느 프로그래머가 경솔하게 함수를 호출할지도 모른다. 그래놓고 그 불쌍한 프로그래머는 자기 코드가 굼벵이 기어가듯 들어가는 이유를 찾느라 골머리를 앓는다.

 

 

 

 

의무적으로 다는 주석

모든 함수에 Javadocs를 달거나 모든 변수에 주석을 달아야 한다는 규칙은 어리석기 그지없다. 이런 주석은 코드를 복잡하게 만들며, 거짓말을 퍼뜨리고, 혼동과 무질서를 초래한다.

아래와 같은 주석은 아무 가치도 없다. 오히려 잘못된 정보를 제공할 여지만 만든다.

/**
*
* @param title CD 제목
* @param author CD 저자
* ...
*/
public void addCD(String title, String author, ...) {
Cd cd = new CD();
cd.title = title;
cd.author = author;
...
}

 

 

이력을 기록하는 주석

때때로 사람들은 모듈을 편집할 때마다 모듈 첫머리에 주석을 추가한다. 그리하여 모듈 첫머리 주석은 지금까지 모듈에 가한 변경을 모두 기록하는 일종의 일지 혹은 로그가 된다.

* 변경 이력 (11-Oct-2001부터)
* --------------------------
* 11-Oct-2001 : 클래스를 다시 정리하고 새로운 패키지인 com.jrefinery.date로 옮겼다. (DG);
* 05-Nov-2001 : getDescription() 메서드를 추가했으며 NotableDate class를 제거했다. (DG);
...

하지만 이제는 소스 코드 관리 시스템이 존재하므로, 완전히 제거하는 편이 좋다.

 

 

있으나 마나 한 주석

떄때로 있으나 마나 한 주석을 접한다. 쉽게 말해, 너무 당연한 사실을 언급하며 새로운 정보를 제공하지 못하는 주석이다.

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

}

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

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

위와 같은 주석은 지나친 참견이라 개발자가 주석을 무시하는 습관에 빠진다. 결국은 코드가 바뀌면서 주석은 거짓말로 변한다. 있으나 마나 한 주석을 달려는 유혹에서 벗어나 코드를 정리하라.

 

무서운 잡음

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

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

위 주석을 한 번 더 주의 깊게 읽어보자. 잘라서 붙여넣기 오류가 보이는가? 주석을 작성한 (혹은 붙여넣은) 저자가 주의를 기울이지 않았다면 독자가 여기서 무슨 이익을 얻겠는가?

 

 

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

4장에서 맨 처음에 언급한, "코드를 의도로 언급하라" 부분과 유사함.

다음 코드를 살펴보자.

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

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

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

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

 

위치를 표시하는 주석

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

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

일반적으로 위와 같은 주석은 가독성만 낮추므로 제거해야 마땅하다. 특히 뒷부분에 슬래시(/)로 이어지는 잡음은 제거하는 편이 좋다.

 

 

 

닫는 괄호에 다는 주석

때로는 프로그래머들이 닫는 괄호에 특수한 주석을 달아놓는다. 우리가 선호하는 작고 캡슐화된 함수에는 잡음일 뿐이다. 그러므로 닫는 괄호에 주석을 달아야겠다는 생각이 든다면 대신에 함수를 줄이려 시도하자.

try {
	while ((line = in.readLine()) != null) {
    	...
    } // while
} // try
catch (IOException e) {
	...
} // catch

 

 

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

/* 개발자 A가 추가함 */

현실적으로 이런 주석은 그냥 오랫동안 코드에 방치되어 점차 부정확하고 쓸모없는 정보로 변하기 쉽다. 위와 같은 정보는 소스코드 관리 시스템에 저장하는 편이 좋다.

 

 

주석으로 처리한 코드

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

InputStreamResponse response = new InputStreamResponse();
// InputSTream resultsTream = formatter.getResultStream();
// StreamReader reader = new StreamReader(resultsStream);

주석으로 처리한 코드는 다른 사람들이 지우기를 주저한다. 이유가 있어 남겨놓았으리라고, 중요하니까 지우면 안 된다고 생각한다. 그래서 쓸모 없는 코드가 점차 쌓여간다.

 

 

HTML 주석

소스코드에서 HTML 주석은 혐오 그 자체다.

/**
* 적합성 테스트를 수행하기 위한 과업
* 이 과업은 적합성 테스트를 수행해 결과를 출력한다.
* <p/>
* <pre>
* 용법:
* &lt;taskdef name=&quot;execute-fitnesse-tests&quot;
*/

 

전역 정보

주석을 달아야 한다면 근처에 있는 코드만 기술하라. 코드 일부에 주석을 달면서 시스템의 전반적인 정보를 기술하지 마라. 

아래 Javadocs 주석을 살펴보면, 함수 자체는 포트 기본값을 전혀 통제하지 못한다. 그러니까 아래 주석은 바로 아래 함수가 아니라 시스템 어딘가에 있는 다른 함수를 설명한다는 말이다. 

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

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

 

 

너무 많은 정보

주석에다 흥미로운 역사나 관련 없는 정보를 장황하게 늘어놓지 마라. 다음은 RFC 번호를 제외하면 독자에게 불필요하며 불가사의한 정보일 뿐이다.

/*
RFC 2045 - Multipurpose Internet Mall Extensions (MIME)
1부: 인터넷 메시지 본체 형식
6.8절. Base64 내용 전송 인코딩
인코딩 과정은 입력 비트 중 24비트 그룹을 인코딩된 4글자로 구성된
...
*/

 

모호한 관계

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

아래는 아파치 commons에서 가져온 주석이다. 

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

여기서 필터 바이트란 무엇일까? 200을 추가하는 이유는? 주석을 다는 목적은 코드만으로 설명이 부족해서다. 주석 자체가 다시 설명을 요구하니 안타깝기 그지없다.

 

 

함수 헤더

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

 

 

 

비공개 코드에서 Javadocs

공개 API는 Javadocs가 유용하지만 공개하지 않을 코드라면 Javadocs는 쓸모가 없다. 유용하지 않을 뿐만 아니라 Javadocs 주석이 요구하는 형식으로 인해 코드만 보기 싫고 산만해질 뿐이다.