[개발서적] Clean Code 4. 주석

잘 달린 주석은 그 어떤 정보보다 유용하다. 경솔하고 근거 없는 주석은 코드를 이해하기 어렵게 만든다.

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

그러므로 주석이 필요한 상황에 처하면 곰곰이 생각하기 바란다. 주석을 달 때마다 자신에게 표현력이 없다는 사실을 푸념해야 마땅하다.

 

코드는 변화하고 진화한다. 불행하게도 주석이 언제나 코드를 따라가지는 않는다.

그래서 나라면 코드를 깔끔하게 정리하고 표현력을 강화하는 방향으로, 그래서 애초에 주석이 필요 없는 방향으로 에너지를 쏟겠다.

진실은 한 곳에만 존재한다. 바로 코드다. 그러므로 우리는 (간혹 필요할지라도) 주석을 가능한 줄이도록 꾸준히 노력해야 한다.

 

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

코드에 주석을 추가하는 일반적인 이유는 코드 품질이 나쁘기 때문이다.

표현력이 풍부하고 깔끔하며 주석이 거의 없는 코드가, 복잡하고 어수선하며 주석이 많이 달린 코드보다 훨씬 좋다.

 

[코드로 의도를 표현하라!]

확실히 코드만으로 의도를 설명하기 어려운 경우가 존재한다. 다음 코드 예제 두 개를 살펴보자. 어느 쪽이 더 나은가?

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

---

if (employee.isEligibleForFullBenefits())

 

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

 

[좋은 주석]

어떤 주석은 필요하거나 유익하다. 하지만 명심하기 바란다. 정말로 좋은 주석은, 주석을 달지 않을 방법을 찾아낸 주석이라는 사실을!

 

법적인 주석

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

 

다음 FitNess에서 모든 소스 파일 첫머리에 추가한 표준 주석 헤더다.

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

 

정보를 제공하는 주석

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

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

 

위 주석은 추상 메서드가 반환할 값을 설명한다. 가능하다면, 함수 이름에 정보를 담는 편이 더 좋다.

 

예를 들어, 위 코드는 함수 이름을 responderBeingTested로 바꾸면 주석이 필요 없어진다.

 

의도를 설명하는 주석

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

public void testConcurrentAddWidgets() throws Exception {
	WidgetBuilder widgetBuilder = 
		new WidgetBuilder(new Class[]{ BoldWidget.class});
		...
		
		// 스레드를 대량 생성하는 방법으로 어떻게든 경쟁 조건을 만들려 시도한다.
		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");
	
	...
	
	assertTrue(a.compareTo(a) == 0); // a == a
	assertTrue(a.compareTo(b) != 0); // a != b
	assertTrue(ab.compareTo(ab) == 0); // ab == ab
	
	...
}

 

물론 그릇된 주석을 달아놓을 위험은 상당히 높다. 이것이 의미를 명료히 밝히는 주석이 필요한 이유인 동시에 주석이 위험한 이유이기도 하다.

 

결과를 경고하는 주석

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

// 여유 시간이 충분하지 않다면 실행하지 마십시오.
public void _testWithReallyBigFile() {
	writeLinesToFile(100000000000);
	
	response.setBody(testFile);
	assertSubString("Content-Length: 100000000000", responseString);
	assertTrue(bytesSent > 100000000000);
}

 

물론 요즘에는 @Ignore 속성을 이용해 테스트 케이스를 꺼버린다. 예를 들어, @Ignore(”실행이 너무 오래 걸린다.”)라고 쓴다.

 

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

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

 

TODO 주석

때로는 ‘앞으로 할일’을 //TODO 주석으로 남겨두면 편하다.

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

 

TODO 주석은 프로그래머가 필요하다 여기지만, 당장 구현하기 어려운 업무를 기술한다.

 

그래도 TODO로 떡칠한 코드는 바람직하지 않으니 주기적으로 TODO 주석을 점검해 없애도 괜찮은 주석은 없애라고 권한다.

 

중요성을 강조하는 주석

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

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

return buildList(text.substring(match.end()));

 

[나쁜 주석]

대다수 주석이 이 범주에 속한다. 어떤 주석이 나쁜 주석에 속하는지 살펴보자.

 

주절거리는 주석

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

주석을 달기로 결정했다면 충분한 시간을 들여 최고의 주석을 달도록 노력한다.

 

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

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

 

catch 블록에 있는 주석은 무슨 뜻일까? 확실히 저자에게야 의미가 있겠지만 그 의미가 다른 사람들에게 전해지지 않는다.

 

답을 알아내려면 다른 코드를 뒤져보는 수밖에 없다.

이해가 안 되어 다른 모듈까지 뒤저야 하는 주석은 독자와 제대로 소통하지 못하는 주석이다.

 

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

목록 4-1은 간단한 함수로, 헤더에 달린 주석이 같은 코드 내용을 그대로 중복한다.

 

목록 4-1 waitForClose

// 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");
		}
	}
}

 

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

 

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

 

목록 4-2 ContainerBase.java (톰캣)

puiblic abstract class ContainerBase 
	implements Container, Lifecycle, Pipeline, 
	MBeanRegistration, Serializable {
	
	/**
		* 이 컴포넌트의 프로세서 지연값		
		*/
	protected int backgroundProcessorDelay = -1;
	
	/**
		* 이 컴포넌트를 지원하기 위한 생명주기 이벤트		
		*/
	protected LifecycleSupport = new LifecycleSupport(this);
	
	...
	
}

 

오해할 여지가 있는 주석

때때로 의도는 좋았으나 프로그래머가 딱 맞을 정도로 엄밀하게는 주석을 달지 못하기도 한다.

목록 4-1에서 본 주석을 떠올려보자. 목록 401 주석은 중복이 상당히 많으면서 오해할 여지가 살짝 있다.

 

의무적으로 다는 주석

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

 

예를 들어 목록 4-3을 보면 주석은 아무 가치가 없다.

오히려 코드만 헷갈리게 만들며, 거짓말할 가능성을 높이며, 잘못된 정보를 제공할 여지만 만든다.

 

목록 4-3

/**
	*
	* @param title CD 제목
	* @param author CD 저자
	* @param tracks CD 트랙 숫자
	* @param durationInMinutes CD 길이(단위: 분)
	*/
public void addCD(String titile, 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);	
}

 

이력을 기록하는 주석

때때로 사람들은 모듈을 편집할 때마다 모듈 첫머리에 주석을 추가한다.

* 변경 이력 (11-Oct-2001부터)
* -------------------------
* 11-Oct-2001 : 클래스를 다시 정리하고 새로운 패키지인 com.jrefinery.date로 옮겼다 (DG);
...

이제는 소스 코드 관리 시스템이 있으니 완전히 제거하는 편이 좋다.

 

있으나 마나 한 주석

때때로 있으나 마나 한 주석을 접한다.

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

---

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

 

위와 같은 주석은 지나친 참견이라 개발자가 주석을 무시하는 습관에 빠진다. 코드를 읽으며 자동으로 주석을 건너뛴다.

결국은 코드가 바뀌면서 주석은 거짓말로 변한다.

 

목록 4-4에서 첫 번째 주석은 적절해 보인다. 하지만 두 번째 주석은 전혀 쓸모가 없다.

 

목록 4-4 startSending

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

 

있으나 마나 한 주석으로 분풀이를 하는 대신 프로그래머가 코드 구조를 개선했더라면 짜증낼 필요가 없었을 터이다.

 

목록 4-5처럼 마지막 try/catch 블록을 독자적인 함수로 만드는데 노력을 쏟았어야 했다.

 

목록 4-5 startSending(리팩터링한 버전)

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

 

있으나 마나 한 주석을 달려는 유혹에서 벗어나 코드를 정리하라.

 

무서운 잡음

때로는 javadocs도 잡음이다.

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

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

...

 

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

다음 코드를 살펴보자.

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

 

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

 

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

if (moduleDependees.contains(ourSubSystem))

 

위치를 표시하는 주석

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

 

예를 들어, 최근에 살펴보던 프로그램에서 다음 행을 발견했다.

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

 

극히 드물지만 위와 같은 배너 아래 특정 기능을 모아놓으면 유용한 경우도 있긴 있다.

하지만 일반적으로 위와 같은 주석은 가독성만 낮추므로 제거해야 마땅하다.

 

닫는 괄호에 다는 주석

때로는 프로그래머들이 닫는 괄호에 특수한 주석을 달아놓는다.

 

목록 4-6이 좋은 예다. 대부분의 이런 경우, 작고 캡슐화된 함수에는 잡음일 뿐이다.

 

목록 4-6 Wc.java

public class Wc {
public static void main(String[] args) {
	BufferReader in = new BufferReader(new InputStreamReader(System.in));
	String line;
	int lineCount = 0;
	int charCount = 0;
	int wordCount = 0;
	try {
		while ((line = in.readLine() != null) {
			lineCount++;
			charCount = line.length();
			String words[] = line.split("\\\\W");
			wordCount += words.length;
		} //while
		System.out.println("wordCount = " + wordCount);
		System.out.println("charCount = " + charCount);
		System.out.println("lineCount = " + lineCount);
	} //try
	...
}
}

 

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

/* 릭이 추가함 */

 

소스 코드 관리 시스템은 누가 언제 무엇을 추가했는지 귀신처럼 기억한다. 그러니 저자 이름으로 코드를 오염시킬 필요가 없다.

 

주석으로 처리한 코드

주석으로 처리한 코드만큼 밉살스러운 관행도 드물다.

 

다음과 같은 코드는 작성하지 마라!

InputStreamResponse response = new InputStreamResponse();
response.setBody(formatter.getResultStream(), formatter.getByteCount());
// InputStream resultsStream = formatter.getResultStream();
// StreamReader reader = new StreamReader(resultStream);
// response.setContent(reader.read(formatter.getByteCount()));

 

주석으로 처리된 코드는 다른 사람들이 지우기를 주저한다. 그래서 질 나쁜 와인병 바닥에 앙금이 쌓이듯 쓸모 없는 코드가 점차 쌓인다.

이제는 소스 코드 관리 시스템이 우리를 대신해 코드를 기억해준다. 이제는 주석으로 처리할 필요가 없다. 그냥 코드를 삭제하라.

 

HTML 주석

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

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

 

전역 정보

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

 

예를 들어 아래 주석은 기본 포트 정보를 기술한다. 하지만 함수 자체는 포트 기본값을 전혀 통제하지 못한다.

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

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

 

너무 많은 정보

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

 

RFC 번호를 제외하면 독자에게 불필요하며 불가사의한 정보일 뿐이다.

/*
RFC 2045 - Multipurpose Internet Mail Extesions (MINE)
1부: 인터넷 메시지 본체 형식
6.8절. Base64 내용 전송 인코딩(Content-Transfer-Encoding)
인코등 과정은 ~~
*/

 

모호한 관계

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

 

예를 들어, 다음은 아파치 commons에서 가져온 주석이다.

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

 

여기서 필터 바이트란 무엇일까? +1과 관련이 있을까? 주석을 다는 목적은 코드만으로 설명이 부족해서다.

 

주석 자체가 다시 설명을 요구하니 안타깝다.