계속 수정됩니다.
나쁜 코드에 주석을 달지 마라. 새로 짜라.
- 브라이언 W. 커니핸, P.J. 플라우거
잘 달린 주석은 그 어떤 정보보다 유용하다.
경솔하고 근거 없는 주석은 코드를 이해하기 어렵게 만든다.
우리에게 프로그래밍 언어를 치밀하게 사용해 의도를 표현할 능력이 있다면, 주석은 전혀 필요하지 않다.
우리는 코드로 의도를 표현하지 못해 주석을 사용한다.
주석 없이는 자신을 표현할 방법을 찾지 못해 할 수 없이 주석을 사용한다.
주석이 필요한 상황에 처하면 상황을 역전해 코드로 의도를 표현할 방법은 없을까 곰곰이 생각하자.
주석을 달 때마다 자신에게 표현력이 없다는 사실을 푸념해야 마땅하다.
주석은 나쁜 코드를 보완하지 못한다
코드에 주석을 추가하는 일반적인 이유는 코드 품질이 나쁘기 때문이다.
표현력이 풍부하고 깔끔하며 주석이 거의 없는 코드가, 복잡하고 어수선하며 주석이 많이 딸린 코드보다 훨씬 좋다.
코드로 의도를 표현하라!
몇 초만 더 생각하면 코드로 대다수 의도를 표현할 수 있다.
많은 경우 주석으로 달려는 설명을 함수로 만들어 표현해도 충분하다.
// 직원에게 복지 혜택을 받을 자격이 있는지 검사한다.
if ((employee.flags & HOURLY_FLAG) &&
(employee.age > 65))위 코드보다 아래 코드가 낫다.
if (employee.isEligibleForFullBenefits())좋은 주석
어떤 주석은 필요하거나 유익하다.
법적인 주석
때로는 회사가 정립한 구현 표준에 맞춰 법적인 이유로 특정 주석을 넣으라고 명시한다.
각 소스 파일 첫머리에 주석으로 들어가는 저작권 정보, 소유권 정보는 필요하고도 타당하다.
가능하다면, 표준 라이선스나 외부 문서를 참조해도 되겠다.
정보를 제공하는 주석
때로는 기본적인 정보를 주석으로 제공하면 편리하다.
예를 들어, 다음 주석은 추상 메서드가 반환할 값을 설명한다.
// 테스트 중인 Responder 인스턴스를 반환한다.
protected abstract Responder responderInstance();가능하다면, 함수 이름에 정보를 담는 편이 더 좋다.
위 코드는 함수 이름을 responderBeingTested로 바꾸면 주석이 필요 없어진다.
다음은 좀 더 나은 예제다.
// kk:mm:ss EEE, MMM dd, yyyy 형식이다.
Pattern timeMatcher = Pattern.compile(
"\\d*:\\d*:\\d* \\w*, \\\w* \\d*, \\d*");위에 제시한 주석은 정규표현식이 시각과 날짜를 뜻한다고 설명한다.
이왕이면 시각과 날짜를 변환하는 클래스를 만들어 코드를 옮겨주면 더 좋고 더 깔끔하겠다.
그러면 주석이 필요 없어진다.
의도를 설명하는 주석
때때로 주석은 구현을 이해하게 도와주는 선ㅇ르 넘어 결정에 깔린 의도까지 설명한다.
다음은 예제다. 두 객체를 비교할 때 저자는 다른 어떤 객체보다 자기 객체 높은 순위를 주기로 결정했다.
public int compareTo(Object o)
{
if(o instanceof WikiPagePath)
{
WikiPagePath p = (WikiPagePath) o;
String compressedName = StringUtil.join(names, "");
String compressedArgumentName = StringUtil.join(p.names, "");
return compressedName.compareTo(compressedArgumentName);
}
return 1; // 오른쪽 유형이므로 정렬 순위가 더 높다.
}다음은 더 나은 예제다.
// 스레드를 대량 생성하는 방법으로 어떻게든 경쟁 조건을 만들려 시도한다.
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그릇된 주석을 달아놓을 위험은 높다.
예제를 살펴보면 알겠지만 주석이 올바른지 검증하기 쉽지 않다.
그러므로 위와 같은 주석을 달 때는 더 나은 방법이 없는지 고민하고 정확히 달도록 각별히 주의한다.
결과를 경고하는 주석
때로 다른 프로그래머에게 결과를 경고할 목적으로 주석을 사용한다.
// 여유 시간이 충분하지 않다면 실행하지 마십시오.
public void _testWithReallyBigFile()
{
writeLinesToFile(10000000);
…
}물론 요즘에는 @Ignore 속성을 이용해 테스트 케이스를 꺼버린다.
구체적인 설명은 @Ignore("실행이 너무 오래 걸린다.") 와 같이 속성에 문자열로 넣어준다.
하지만 JUnit4가 나오기 전에는 메서드 이름 앞에 _ 기호를 붙이는 방법이 일반적인 관레였다.
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 주석으로 남겨두면 편하다.
// 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(math.end()));공개 API에서 Javadocs
설명이 잘 된 공개 API는 참으로 유용하고 만족스럽다.
Javadocs가 없다면 자바 프로그램을 짜기가 아주 어려울거다.
공개 API를 구현한다면 반드시 훌륭한 Javadocs를 작성한다.
여느 주석과 마찬가지로 Javadocs 역시 독자를 오도하거나, 잘못 위치하거나, 그릇된 정보를 전달할 가능성이 존재함을 명심하자.
나쁜 주석
대다수 주석이 이 범주에 속한다.
허술한 코드를 지탱하거나, 엉성한 코드를 변명하거나, 미숙한 결정을 합리화하는 등 프로그래머가 주절거리는 독백에서 크게 벗어나지 못한다.
주절거리는 주석
주석을 달기로 결정했다면 충분한 시간을 들여 최고의 주석을 달도록 노력한다.
public void loadProperties()
{
try
{
String propertiesPath = propertiesLocation + "/" + PROPERTIES_FILE;
FileInputStream propertiesStream = new FileInputStream(propertiesPath);
loadedProperties.load(propertiesStream);
}
catch(IOException e)
{
// 속성 파일이 없다면 기본값을 모두 메모리로 읽어 들였다는 의미다.
}
}누가 모든 기본값을 읽어 들이는가?
loadProperties.load를 호출하기 전에 읽어 들이는가?
아니면 loadProperties.load가 파일을 읽어 들이기 전에 모든 기본값부터 읽어 들이는가?
저자가 catch 블록을 비워놓기 뭐해 몇 마디 덧붙였을 뿐인가?
아니면 나중에 돌아와서 기본값을 읽어 들이는 코드를 구현하려 했는가?
답을 알아내려면 다른 코드를 뒤져보는 수밖에 없다.
이해가 안 되어 다른 모듈까지 뒤져야 하는 주석은 독자와 제대로 소통하지 못하는 주석이다.
같은 이야기를 중복하는 주석
헤더에 달린 주석이 같은 코드 내용을 그대로 중복한다.
자칫하면 코드보다 주석 읽는 시간이 더 오래 걸린다.
// 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");
}
}주석이 코드보다 더 많은 정보를 제공하지 못한다.
코드를 정당화하는 주석도 아니고, 의도나 근거를 설명하는 주석도 아니다.
코드보다 읽기가 쉽지도 않다.
실제로 코드보다 부정확해 독자가 함수를 대충 이해하고 넘어가게 만든다.
/**
* 이 컴포넌트를 위한 컨테이너 이벤트 Listener
*/
protected Loader loader = null;오해할 여지가 있는 주석
// 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");
}
}위에서는 다음과 같은 오해의 여지가 있다.
this.closed가 true로 변하는 순간에 메서드는 반환되지 않는다.
this.closed가 true여야 메서드는 반환된다.
아니면 무조건 타임아웃을 기다렸다 this.closed가 그래도 true가 아니면 예외를 던진다.
주석에 담긴 '살짝 잘못된 정보'로 인해 this.closed가 true로 변하는 순간에 함수가 반환되리라는 생각으로 함수를 호출하게 될 수 있다.
이력을 기록하는 주석
예전에는 모든 모듈 첫머리에 변경 이력을 기록하고 관리하는 관례가 바람직했다.
지금은 소스 코드 관리 시스템이 있다.
이제는 혼란만 가중할 뿐이니 완전히 제거하자.
있으나 마나 한 주석
새로운 정보를 제공하지 못하는 주석을 제거하자.
/**
* 기본 생성자
*/
protected AnnualDateRule() {
}
/** 월 중 일자 */
private int dayOfMonth;
/**
* 월 중 일자를 반환한다.
* @return 월 중 일자
*/
public int getDayOfMonth() {
return dayOfMonth;
}위와 같은 주석은 지나친 참견이라 개발자가 주석을 무시하는 습관에 빠진다.
