[클린 코드] 4장 주석

프로그래밍에서 주석(comment)의 정의는 다음과 같다.

Comment is a piece of text placed within a program to help other users to understand it, which the computer ignores when running the program.

 

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

Don't comment bad code—rewrite it.
- Brian W. Kernighan 

 

주석은 오래될수록 코드에서 멀어진다. 프로그래머들이 주석을 유지하고 보수하기란 현실적으로 불가능하기 때문이다. 잘 달린 주석은 그 어떤 정보보다 유용하지만, 오래되고 조잡한 주석은 잘못된 정보로 오히려 코드를 이해하기 어렵게 만든다. 

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

 

코드로 의도를 표현하라!

코드로 의도를 표현하지 못할 때, 실패를 만회하기 위해 주석을 사용한다. 상황을 역전해 코드로 의도를 표현할 방법은 없을까? 코드로 의도를 표현할 때마다 스스로를 칭찬하고, 주석을 달 때마다 자신에게 표현력이 없다는 사실에 푸념해야 마땅하다.

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

// ✅
if (employee.isEligibleForFullBeneifts()) { 
  // ... 
}

 

 

좋은 주석

정보를 제공하는 주석 

기본적인 정보를 주석으로 제공하면 편리하다. 하지만 주석이 필요없게 개선할 수도 있다.

// ✅
// 테스트 중인 Responder 인스턴스를 반환합니다.
protected abstract responderInstance(): Responder ;

// ✅✅
protected abstract responderBeingTested(): Responder;

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

// ✅✅
// 시각과 날짜를 변환하는 클래스를 만들어 코드를 옮겨줍니다.

 

의도를 설명하는 주석

주석에는 의사결정을 기록할 수 있다. 이러한 주석에는 저자가 문제를 해결하는 방식이 분명하게 드러난다.

// ✅
const compareTo(o: Object) => {
  if (o instanceof WikiPagePath) {
    // ...
    return ...
  }
  return 1; // 옳은 유형이므로 정렬 순위가 높습니다.
}

const testConcurrentAddWidgets = (): void {
  // 스레드를 대량 생성하는 방법으로 어떻게든 경쟁 조건을 만들려 시도합니다.
  for (let i = 0; i < 25_000, i++) {
    // ...
  }
}

 

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

표준 라이브러리이거나 해서 변경하지 못하는 코드라면 의미를 명료하게 밝히는 주석이 유용하다.

 

결과를 경고하는 주석

다른 프로그래머에게 결과를 경고할 목적으로 주석을 사용한다. (ts-ignore, ts-expect-error 와 비슷하다. 관련 아티클)

// ✅
// @ignore ("실행 시간이 너무 오래걸립니다.")
const _testWithReallybigFile = (): void => {
  // ...
}

다음 주석은 프로그램 효율을 높이기 위해 정적 초기화 함수를 사용하려던 열성적인 프로그래머가 실수를 하는 것을 면하게 해준다.

// ✅
const makeStandardHttpDateFormat: SimpleDateFormat = () => {
  // SimpleDateFormat는 스레드에 안전하지 못합니다.
  // 따라서 각 인스턴스를 독립적으로 생성해야 합니다.
  const df = new SimpleDateFormat("EEE, dd MMM  yyyy HH:mm:ss z")
  // ...
}

 

TODO 주석

TODO 주석은 유용하지만, 주기적으로 점검해서 없애도 괜찮은 주석은 없애는 것이 좋다.

 

중요성을 강조하는 주석

중요한데 대수롭지 않게 넘어갈 수도 있는 부분이라면, 중요성을 강조하기 위해 주석을 사용한다.

// ✅
// 여기서 trim은 정말 중요합니다. trim 함수는 문자열에서 시작 공백을 제거합니다.
// 문자열에 시작 공백이 있으면 다른 문자열로 인식되기 때문입니다.

 

공개 API에서 TSDoc/JSDoc

공개 API를 구현한다면 반드시 훌륭한 TSDoc/JSDoc를 작성해야 한다. 여느 주석과 마찬가지로 TSdoc/JSDoc 역시 독자를 오도하거나 잘못 위치하거나 그릇된 정보를 전달할 가능성은 존재한다.

 

나쁜 주석

주절거리는 주석

혼자만 이해할 수 있는 주석을 다는 경우가 있다. 혼자 주절거린 이 내용을 이해하려면 독자는 다른 코드를 뒤져보는 수 밖에 없다. 이렇게 독자와 제대로 소통하지 못하는 주석은 바이트만 낭비할 뿐이다.

 

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

함수에 달린 주석이 코드 내용을 그대로 중복한 경우, 자칫 코드 읽는 시간보다 주석 읽는 시간이 더 오래 걸릴 수 있다. 실제로 코드보다 부정확해 독자가 함수를 대충 이해하고 넘어가게 만들기도 한다. 엔진 후드를 열어볼 필요가 없다며 고객에게 아양떠는 중고차 판매원과 비슷하다.

// ❌

// Utility method that returns when closed is true. 
// Throws an exception if the timeout is reached.
const waitForClose = (timeoutMillis: number): void {
  if(!closed) {
    wait(timeoutMillis);
    if(!closed)
      throw new Exception("MockResponseSender could not be closed");
  }
}

// ❌
/** 이 컴포넌트의 프로세서 지연값 */
const backgroundProcessDelay = -1;

 

오해할 여지가 있는 주석

(코드보다 읽기도 어려운) 주서겡 담긴 '살짝 잘못된 정보'로 인해, 어느 불쌍한 프로그래머는 자기 코드가 예상대로 돌아가지 않는 이유를 찾느라 골머리를 앓게 된다.

 

의무적으로 다는 주석

모든 함수에 TSDoc/JSDoc을 달거나 모든 변수에 주석을 달아야 한다는 규칙은 어리석기 그지없다. 이런 주석은 아무런 가치가 없다. 오히려 잘못된 정보를 제공할 여지만 만든다.

 

있으나 마나 한 주석

너무 당연한 사실을 언급하며 새로운 정보를 제공하지 못하는 주석은 전형적인 '중복'이다. 이런 코드는 개발자가 코드를 읽는 은연 중에 무시하기 쉽고, 결국 코드가 변경될 때도 주석은 무시되어 거짓말을 하는 주석으로 남게된다.

// ❌
/** 월 중 일자 */
let dayOfMonth;

 

 

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

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

// ✅
const moduleDependees = smodule.getDependSubSystems();
const ourSubSystem = subSysMod.getSubSystem();

if (moduleDependees.contains(ourSubSystem)) {
  // ...
}

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

 

위치를 표시하는 주석

주석을 배너처럼 만들어서 특정 기능을 모아놓으면 유용한 경우도 있긴 하다. 하지만 일반적으로 가독성을 낮추고 다음과 같은 슬래시는 잡은 처럼 느껴져 제거하는 것이 좋다.

// ❌
// Actions ////////////////////////////////////

 

닫는 괄호에 다는 주석

닫는 괄호에 특수한 주석을 다는 것은 중첩이 심하고 장황한 함수에서 의미가 있을지 모른다. 하지만 우리가 추구하는 작고 캡슐화된 함수에서는 잡음일 뿐이다. 닫는 괄호에 주석을 달아야겠다는 생각이 든다면 함수를 줄이려 시도하자.

// ❌
try {
  while ((line = in.readLine()) !== null) {
    lineCount++;
    charCount += line.length();
    const words = line.split(/\\w/g);
    wordCounts += words.length
  } // while
  console.log('wordCount :' + wordCount);
  console.log('lineCount :' + lineCount);
  console.log('charCount :' + charCount);
} // try
catch (e) {
  console.error('error :' + e.message);
} // catch

 

주석으로 처리한 코드

주석으로 처리한 코드는 다른 사람들이 지우기를 주저한다. 이유가 있어서 중요하니까 지우면 안된다고 생각한다. 현대 프로그래밍에서는 git이 우리를 대신해 코드를 기억해준다. 잃어버릴 염려가 없으니 그냥 코드를 삭제하라.

 

전역 정보

주석을 달아야 한다면 근처에 있는 코드만 기술하라. 코드 일부에 주석을 달면서 시스템의 전반적인 정보를 기술하지 마라. 전역 정보와 관련된 코드가 변해도 주석이 함께 변경되리라는 보장이 전혀 없기 때문이다.

 

비공개 코드에서 TSDoc/JSDoc

공개 API에서는 Doc이 유용하지만 공개하지 않을 코드라면 Doc은 쓸모가 없다. 시스템 내부에 속한 클래스와 함수에 Doc을 생성할 필요는 없다. Doc이 요구하는 형식으로 인해 코드만 보기싫고 산만해질 뿐이다.

 

출처: 도서 클린코드 애자일 소프트웨어 장인 정신, 로버트 C.마틴 지음 | 박재호, 이해영 옮김 | 인사이트