[Clean Code] 3. 주석

주석은 코드만으로는 부족한 설명을 덧붙이기 위해 작성한다. 그러나 우리는 주석으로 코드를 설명하기보다는 코드 자체에 의미를 담아야 한다. 주석이 필요 없는 코드가 가장 좋겠지만, 주석 중에서도 좋은 주석과 나쁜 주석의 종류에 대해 알아보자.

 

주석의 의미

주석은 순수하게 선하지 못하다. 기껏해야 필요악이다. 프로그래밍 언어를 치밀하게 사용해 의도를 표현할 수 있다면 주석은 전혀 필요하지 않을 것이다. 우리는 코드로 의도를 표현하지 못해서, 실패를 만회하기 위해 주석을 사용하므로 주석은 언제나 실패를 의미한다.

주석은 오래될수록 코드에서 멀어진다. 프로그래머들이 주석을 유지 보수하기는 어렵기 때문이다. 코드가 변화하고 진화하면서 주석은 여기저기로 옮겨지기도, 갈라지고 합쳐지기도 하면서 코드를 따라가지 못한다.

진실은 코드에만 존재한다. 코드만이 정확한 정보를 제공한다. 따라서 우리는 주석을 가능한 줄이도록 꾸준히 노력해야 한다.

 

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

일반적으로 코드의 품질이 나쁘기 때문에 주석을 추가하게 된다. 코드가 지저분하다는 사실을 자각하고는 "주석을 달아야겠다!"라고 생각하지만 사실은 코드를 정리해야 한다! 표현력이 풍부하고 깔끔하며 주석이 거의 없는 코드가, 복잡하고 어수선하며 주석이 많이 달린 코드보다 훨씬 좋다.

 

코드로 의도를 표현하라!

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

좋은 주석

법적인 주석

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

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

 

정보를 제공하는 주석

때로는 기본적인 정보를 주석으로 제공하면 편리한데, 이런 주석이 유용하다 할지라도 가능하다면 함수 이름에 정보를 담는 편이 더 좋다.

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

protected abstract Responder responderBeingTested();

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

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

 

의도를 설명하는 주석

때때로 주석은 결정에 깔린 의도까지 설명한다. 저자가 문제를 해결한 방식에 동의하지 않을지도 모르지만 어쨌든 저자의 의도가 분명히 드러나게 할 수 있다.

 

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

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

물론 주석이 올바른지 검증하기 쉽지 않기 때문에 의미를 명료히 밝히는 주석이 필요하면서도 동시에 위험하다.

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

 

결과를 경고하는 주석

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

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 주석으로 남겨두면 편하다. 필요하다 여기지만 당장 구현하기 어려운 업무를 기술한다. 대다수의 IDE는 TODO 주석 전부를 찾아서 보여주는 기능을 제공하므로 잊어버릴 염려는 없지만, 주기적으로 점검해서 없애도 괜찮은 주석은 없애라고 권한다.

 

중요성을 강조하는 주석

자칫 대수롭지 않게 여길 수 있는 무언가의 중요성을 강조하기 위해서 주석을 사용하기도 한다.

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

 

공개 API에서 Javadocs

표준 자바 라이브러리에서 사용한 Javadocs가 없다면 자바 프로그램을 짜기가 아주 어려울 것이다. 공개 API를 구현한다면 반드시 훌륭한 Javadocs를 작성한다. 하지만 여느 주석과 마찬가지로 독자를 오도하거나, 잘못된 위치에 있거나, 그릇된 정보를 전달할 가능성이 존재한다.

 

 

나쁜 주석

대다수 주석은 허술한 코드를 지탱하거나, 엉성한 코드를 변경하는 등 나쁜 주석에 속한다.

 

주절거리는 주석

특별한 이유 없이 주석을 단다면 전적으로 시간낭비다. 주석을 달기로 했다면 충분한 시간을 들여 최고의 주석을 달도록 노력해야 한다.

저자가 주절거려 놓은 주석은 결국 이해가 안 되어서 다른 모듈까지 뒤져봐야 하고, 이는 독자와 제대로 소통하지 못하는 주석이다. 이런 주석은 바이트만 낭비할 뿐이다.

 

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

코드보다 더 많은 정보를 제공하지 못하는 주석은 독자가 코드를 대충 이해하고 넘어가게 만든다. 아래 코드는 쓸모없고 중복된 Javadocs가 매우 많은데, 기록이라는 목적에 전혀 기여하지 못하고 코드만 지저분하고 정신없게 만든다.

public abstract class ContainerBase
	implements Container, Lifecycle, Pipeline, MBeanRegistration, Serializable {

	/**
	* 이 컴포넌트의 프로세서 지연값
	*/
	protected int backgroundProcessorDelay = -1;
	...
	
	/**
	* 컨테이너와 관련된 Cluster
	*/
	protected Cluster cluster = null;

	...
}

 

오해할 여지가 있는 주석

의도는 좋았으나 오해할 여지가 있는 주석을 달면 안 된다. 주석에 담긴 살짝 잘못된 정보로 인해 다른 프로그래머가 잘못된 용도로 함수를 호출하게 되면 문제가 생겨도 원인을 찾기 어려워진다.

 

의무적으로 다는 주석

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

 

이력을 기록하는 주석

모듈을 편집할 때마다 모듈 첫머리에 주석을 추가하면 이는 지금까지 모듈에 가한 변경을 모두 기록하는 일족의 일지 또는 로그가 된다. 예전에는 이런 관례가 바람직했지만, 소스 코드 관리 시스템이 있는 지금은 혼란만 가중할 뿐이므로 완전히 제거하는 편이 좋다.

 

있으나 마나 한 주석

너무 당연한 사실을 언급하며 새로운 정보를 제공하는 주석은 있으나 마나 하다. 그러한 주석은 지나친 참견이기 때문에 개발자가 무시하는 습관에 빠지고, 결국은 코드가 바뀌면서 주석은 거짓말로 변한다.

 

무서운 잡음

때로는 Javadocs도 잡음이 된다. 반드시 Javadocs를 제공해야 한다는 잘못된 욕심으로 탄생한 잡음을 아래에서 확인할 수 있다. 심지어 복사 붙여 넣기 오류도 존재한다. 저자조차 주의를 기울이지 않은 주석에서 독자는 아무 이익도 얻을 수 없다.

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

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

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

 

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

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

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

위 코드에서 주석을 없애고 다시 표현하면 아래 코드가 된다. 위와 같이 주석이 필요하지 않도록 코드를 개선하는 것이 더 좋다.

 

위치를 표시하는 주석

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

위와 같은 배너 아래에 특정 기능을 모아 놓으면 유용한 경우도 있긴 있다. 그렇지만 일반적으로는 가독성만 낮춘다. 특히 슬래시로 이어지는 잡음은 제거하는 편이 좋다.

너무 자주 사용하지 않는다면 배너는 눈에 띄고 주의를 환기한다. 따라서 반드시 필요할 때만 아주 드물게 사용하는 것이 좋다. 남용하면 독자가 흔한 잡음으로 여겨 무시할 것이다.

 

닫는 괄호에 다는 주석

try {
	while (( ... )) {
		...
	} //while
	...
} //try

위 코드처럼 닫는 괄호에 특수한 주석을 달아놓는 프로그래머들도 있다. 중첩이 심하고 장황한 함수라면 의미가 있을 수도 있겠지만 우리가 선호하는 작고 캡슐화된 함수에서는 잡음이 될 뿐이다. 이런 주석을 달기보다는 함수를 작게 만들려고 노력하자.

 

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

소스 코드 관리 시스템은 누가 언제 무엇을 추가했는지 모두 알고 있다. 그러므로 저자 이름을 남겨 코드를 더럽힐 필요가 없다.

 

주석으로 처리한 코드

주석으로 처리된 코드는 다른 사람이 지우기를 주저한다. 뭔가 이유가 있어서 남겨놓았을 것이라고 생각한다. 그렇게 쓸모없는 코드가 점차 쌓여간다. 소스코드 관리 시스템이 코드를 모두 기억하므로 주석으로 처리하지 말고 그냥 삭제하는 편이 좋다.

 

HTML 주석

코드에 HTML 주석은 혐오 그 자체다. 주석을 읽기 쉬워야 하는 IDE에서조차 HTML 주석은 읽기 어렵다.

 

전역 정보

주석을 달아야 한다면 근처에 있는 코드에 대한 내용만 기술하라. 시스템의 전반적인 정보를 기술하면 안 된다. 주석과 관련된 코드가 변해도 이 주석도 변하리라는 보장이 없다.

 

너무 많은 정보

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

 

모호한 관계

주석과, 주석이 설명하는 코드는 둘 사이의 관계가 명백해야 한다. 코드만으로 설명이 부족해서 주석을 다는 것인데 주석 자체가 다시 설명을 요구한다면 안타깝기 그지없다.

 

함수 헤더

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

 

비공개 코드에서 Javadocs

공개하지 않을 코드에서 Javadocs는 쓸모없다. 유용하지도 않을 뿐만 아니라 코드만 보기 싫고 산만해진다.

 

 

 

참고 서적: <Clean Code(클린 코드):애자일 소프트웨어 장인 정신>

Clean Code(클린 코드):애자일 소프트웨어 장인 정신

이 포스팅은 쿠팡 파트너스 활동의 일환으로, 이에 따른 일정액의 수수료를 제공받습니다.