4장: 주석

개요

• 잘 달린 주석은 그 어떤 정보보다 유용하다. 경솔하고 근거 없는 주석은 코드를 이해하기 어렵게 만든다. 오래되고 조잡한 주석은 거짓과 잘못된 정보를 퍼뜨려 해악을 미친다.

• 우리는 코드를 의도로 표현하지 못해, 다시 말해 실패를 만회하기 위해 주석을 사용한다.

• 주석이 필요한 상황에 처하면 상황을 역전해 코드로 의도를 표현할 방법을 생각해보자.

• 주석은 거짓말을 한다. 항상도 아니고, 고의적인 것도 아니지만 자주 거짓말을 한다.

• 주석은 오래될수록 코드에서 멀어진다. 오래될수록 완전히 그릇될 가능성도 커진다.

• 진실은 한 곳에만 존재한다. 바로 코드!

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

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

코드를 의도로 표현하라!

• 확실히 코드만으로 의도를 설명하기 어려운 경우가 존재한다. 그러나 이것이 코드가 훌륭한 수단이 아니라는 의미는 아니다.

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

if (employee.isEligibleForFullBenefits())

• 조금만 생각하면 코드로 대다수 의도를 표현할 수 있다.

좋은 주석

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

법적인 주석

• 때로는 회사가 정립한 구현 표준에 맞춰 법적인 이유로 특정 주석을 넣으라고 명시한다.

  • 저작권 정보, 소유권 정보, 표준 라이선스 등

정보를 제공하는 주석

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

• 주석이 유용하다 할지라도 가능하다면 함수 이름에 정보를 담는 편이 더 좋다.

의도를 설명하는 주석

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

의미를 명료하게 하는 주석

• 때때로 모호한 인수나 반환값은 그 의미를 읽기 좋게 표현하면 이해하기 쉬워진다.

• 인수나 반환값이 표준 라이브러리나 변경하지 못하는 코드에 속한다면 의미를 명료하게 밝히는 주석이 유용하다.

• 하지만 그릇된 주석을 달아놓을 위험은 상당히 높다. 이 주석이 올바른지 검증하기 쉽지 않다.

결과를 경고하는 주석

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

TODO 주석

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

  • 더 이상 필요 없는 기능을 삭제하라는 알림

  • 누군가에게 문제를 봐달라는 요청

  • 더 좋은 이름을 떠올려달라는 부탁

  • 앞으로 발생할 이벤트에 맞춰 코드를 고치라는 주의 등

• 하지만 어떤 용도로 사용하든 시스템에 나쁜 코드를 남겨놓는 핑계가 되어서는 안 된다.

중요성을 강조하는 주석

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

공개 API에서의 JavaDocs

• 설명이 잘 된 공개 API는 참으로 유용하고 만족스럽다. (ex. 표준 자바 라이브러리의 Javadocs)

나쁜 주석

주절거리는 주석

• 특별한 이유 없이 의무감으로 혹은 프로세스에서 하라고 하니까 마지못해 주석을 단다면 전적으로 시간남비다. 주석을 달기로 결정했다면 충분한 시간을 들여 최고의 주석을 달도록 노력한다.

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

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

• 위와 같은 코드는 주석이 코드보다 더 많은 정보를 제공하지 못한다. 오히려 코드보다 주석을 읽는 시간이 더 오래 걸린다.

오해할 여지가 있는 주석

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

• 오해할 여지가 있는 주석으로 잘못된 결과를 도출할 수 있다.

의무적으로 다는 주석

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

이력을 기록하는 주석

• 예전에는 변경 이록을 기록하고 관리하는 관례가 바람직했으나, 지금처럼 소스 코드 관리 시스템이 있는 환경이라면 불필요하다.

있으나 마나 한 주석

• 너무 당연한 사실을 언급하며 새로운 정보를 제공하지 못하는 주석은 있으나 마나 하다.

무서운 잡음

• 때로는 Javadocs도 잡음이다.

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

위치를 표시하는 주석

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

• 너무 자주 사용하지 않는다면 배너는 눈에 띄며 주의를 환기한다. 그러므로 반드시 필요할 때만, 아주 드물게 사용하는 편이 좋다.

닫는 괄호에 다는 주석

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

• 중첩이 심하고 장황한 함수라면 의미가 있을지도 모르나, 작고 캡슐화된 함수에는 잡음일 뿐이다.

• 닫는 괄호에 주석을 다는 것보단 함수로 줄이려 시도하자!

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

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

주석으로 처리한 코드

• 주석으로 처리한 코드는 다른 사람들이 지우기를 주저한다. 이유가 있어 남겨놓았으리라고, 중요하니까 지우면 안 된다고 생각한다.

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

HTML 주석

• HTML 주석은 혐오 그 자체다!

• HTML 주석은 편집기에서조차 읽기가 어렵다. Javadocs 등의 도구로 주석을 뽑아 웹 페이지에 올릴 작정이라면 주석에 HTML 태그를 삽입해야 하는 책임은 프로그래머가 아니라 도구가 져야 한다.

전역 정보

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

너무 많은 정보

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

모호한 관계

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

함수 헤더

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

비공개 코드에서 JavaDocs

• 공개 API는 Javadocs가 유용하지만, 공개하지 않을 코드라면 Javadocs는 쓸모가 없다.