[클린 코드] 챕터4 주석1

4 분 소요

주석은 쉰들러 리스트가 아니다. 주석은 ‘순수하게 선하지’ 못하다. 사실상 주석은 기껏해야 필요악이다. 프로그래밍 언어 자체가 표현력이 풍부하다면, 아니 우리에게 프로그래밍 언어를 조율해 의도를 표현할 능력이 있다면, 주석은 거의 필요하지 않으리라. 아니 전혀 필요하지 않으리라.

우리는 코드로 의도를 표현하지 못해, 그러니까 실패를 만회하기 위해 주석을 사용한다. 주석은 언제나 실패를 의미한다. 때때로 주석 없이 자신을 표현할 방법을 못 찾아서 할 수 없이 주석을 사용한다. 그래서 주석은 반겨 맞을 손님이 아니다.

주석이 필요한 상황에 처하면 곰곰이 생각하기 바란다. 상황을 역전해 코드로 의도를 표현할 방법은 없을까? 코드로 의도를 표현할 때마다 스스로를 칭찬하자.🙂 주석을 달때마다 자신에게 표현력이 없다는 사실을 푸념하자.😢

이렇게 주석을 무시하는 이유가 무엇일까? 거짓말을 하니까. 항상도 아니고 고의도 아니지만 너무 자주 거짓말을 하니까. 주석은 오래될수록 코드에서 멀어진다. 오래될수록 완전히 그릇될 가능성도 커진다. 이유는 단순하다.
프로그래머들이 주석을 유지하고 보수하기란 현실적으로 불가능하니까.

코드는 변화하고 진화한다. 일부가 여기서 저기로 옮겨지기도 한다. 조각이 나뉘고 갈라지고 합쳐지면서 괴물로 변한다. 불행하게도 주석이 언제나 코드를 따라가지 않는다. 아니, 따라가지 못한다. 주석이 코드에서 분리되어 점점 더 부정확한 고아로 변하는 사례가 너무도 흔하다.

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

부정확한 주석은 독자를 현혹하고 오도한다. 더 이상 지킬 필요가 없는 규칙이나 지켜서는 안 되는 규칙을 명시한다. 진실은 한 곳에만 존재한다. 바로 코드다. 코드만이 자기가 하는 일을 진실하게 말한다. 코드만이 정확한 정보를 제공하는 유일한 출처다. 그러므로 우리는 주석을 가능한 줄이도록 꾸준히 노력해야 한다.

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

코드에 주석을 추가하는 일반적인 이유는 코드 품질이 나쁘기 때문이다. 모듈을 짜고 보니 짜임새가 엉망이고 알아먹기 어렵다. 지저분한 모듈이라는 사실을 자각한다. 그래서 자신에게 이렇게 말한다.

“이런! 주석을 달아야겠다!” 아니다! 코드를 정리해야 한다.

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

자신이 저지른 난장판을 주석으로 설명하려 애쓰는 대신에 그 난장판을 깨끗이 치우는데 시간을 보내라!

4.2 코드로 의도를 표현하라

확실히 코드만으로 의도를 설명하기 어려운 경우가 존재한다. 불행하게도 많은 개발자가 이것때문에 코드는 훌륭한 수단이 아니라는 의미로 해석한다. 하지만 잘못된 생각이다. 다음예제를 살펴보다

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

if(employee.isEligibleForBenefits())

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

4.3 좋은 주석

어떤 주석은 필요하거나 유익하다. 글자 값을 한다고 생가가는 주석 몇 가지를 소개한다. 하지만 정말로 우수한 주석은 달지 않을 방법을 찾아낸 주석이라는 사실을 알기를 바란다.

법적인 주석

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

하지만 원시 파일 첫머리에 들어가는 주석이 반드시 계약 조건이나 법적인 정보일 필요는 없다. 모든 조항과 조건을 열거하는 대신에 가능하면 표준 라이선스나 외부 문서를 참조해도 되겠다.

정보를 제공하는 주석

때로는 주석으로 기본적이 정보를 제공하면 편리하다. 예를 들어, 다음 주석은 추상 메소드가 반환할 값을 설명한다.

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

때때로 위와 같은 주석이 유용하다 할지라도, 가능하면, 함수 이름에 정보를 담는 편이 더 낫다. 예를 들어, 위 코드는 함수 이름을 responderBeingTested로 바꾸면 주석이 필요 없어진다.

의도를 설명하는 주석

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

// 스레드를 대량 생성하는 방법으로 어떻게든 경쟁 조건을 만들려 시도한다.
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 속성에 문자열로 넣어준다.(@Ignore(“실행이 너무 오래 걸린다.”)

위에 제시한 주석은 (다소 경박스럽지만)매우 적절한 지적이다.

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

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 주석으로 설명한 예제다.

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

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 역시 독자를 오도하거나, 잘못 놓이거나, 그릇된 정보를 전달할 가능성이 존재한다.

참조

로버트 C. 마틴, 『Clean Code 클린 코드』, 박재호, 이해영 옮김, 케이앤피북스(2010), P98-104.

Twitter Facebook LinkedIn

Jusung Kim