CleanCode 4장 주석 에 대해 정리한 포스트입니다.

Overview

나쁜 코드에 주석들 달지 마라. 새로 짜라.

우리는 코드로 의도를 제대로 표현하지 못해 실패를 만회하기 위해 주석을 사용하게 됩니다. 그래서 주석은 항상 신중하게 사용하여야 합니다.

주석을 달 때면 난 코드로 정보를 다 주지 못한다고 푸념을 같이 해야 합니다.

진실은 코드에만 존재합니다.

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

코드에 주석을 추가하는 일반적인 이유 = 코드 품질이 나쁨

  • 주석을 달아 설명하기 보다는 코드를 정리하는 것이 옳습니다.

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

1. 코드로 의도를 표현하라!

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

위 코드보다 아래 코드가 이해가 빠르다는 것을 알 수 있습니다.

if (employee.isEligibleForFullBenefits())
...

대부분의 경우 주석으로 하려는 설명을 함수로 충분히 표현할 수 있습니다.

1. 좋은 주석

필요하거나 유익한 주석도 있습니다.

  1. 법적인 주석(Copyright와 같은)

     Copyright (c) 2003,2004 by ~~~~~~~

  2. 정보를 제공하는 주석

    때로는 기본적인 정보를 주석으로 제공할 때 편리합니다.

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

    이 경우 함수 이름을 responderBeingTested 로 수정하면 주석이 필요 없어집니다.

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

  3. 의도를 설명하는 주석

    때때로 주석은 구현을 이해하게 도와줄 뿐만 아니라 결정에 깔린 의도를 설명하기도 합니다.

     public int compareTo(Object o){
     if(o instanceof WikiPagePath){
         ....
     }
     // ~~한 경우에는 우선순위가 높다.
     return 1;
 }

     public void testConcurrentAddWidgets() {
     ...
     // 스레드를 대량 생성하는 방법으로 경쟁 조건을 만든다.
     for (int i = 0; i < 25000; i++){
         new Thread(widgetBuilderThread).start();
     }
     ...
 }

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

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

    하지만 주석이 틀린 정보를 제공할 위험이 있기 때문에 신중하게 작성하여야 합니다.

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

  5. 결과를 경고하는 주석

    다른 프로그래머에게 경고할 목적으로 주석을 사용하는 경우에도 유용하게 쓰일 수 있습니다.

     // 여유 시간이 충분하지 않다면 실행하지 마십시오.
 public void _testWithReallyBigFile() {
     ...
 }

     public static SimpleDateFormat makeStanardHttpDateFormat() {
     // SimpleDateFormat은 스레드에 안전하지 못하기 때문에 각 인스턴스를 독립적으로 생성해야 한다.
     SimpleDateFormat df = new SimpleDateFormat(".......");
     return df;
 }

  6. TODO 주석

    앞으로 해야 할 일을 // TODO 주석으로 남겨두는 경우에도 유용하게 쓰입니다. 하지만 나쁜 코드를 남겨놓고 나중에 수정한다는 식의 TODO는 좋지 않습니다.

    하지만 너무 많이 쌓이는 것은 바람직하지 않기 때문에 주기적으로 확인하고 미룬 일을 처리하거나 삭제할 필요가 있습니다.

     // TODO 현재는 필요하지 않다.
 protected VersionInfo makeVersion() {
     return null;
 }

  7. 중요성을 강조하는 주석

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

     String listItemContent = match.group(3).trim();
 // 여기서 trim으로 시작공백을 제거함으로써 다른 문자열로 인식될 위험을 제거합니다.

  8. 공개 API에서 Javadocs

    어느 주석과 마찬가지로 javadocs 또한 잘못된 정보를 제공하거나 잘못 위치할 위험이 있으니 항상 주의깊게 작성해야 한다.

1. 나쁜 주석

대다수의 주석은 나쁜 주석에 속합니다.

  • 허술한 코드를 지탱
  • 엉성한 코드를 변명
  • 미숙한 결정을 합리화

  1. 주절거리는 주석

    특별한 이유 없이 의무감으로 다는 주석은 시간낭비

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

    코드 내용을 서술했을 뿐인 주석은 읽는데 더 시간이 오래 걸립니다.

     // this.closed가 true일 때 반환되는 유틸리티 메서드다.
 // 타임아웃에 도달하면 예외를 던진다.

 public synchronized void waitForClose(final long timeoutMillis) 
     throws Exception{
     if(!closed) {
         wait(timeoutMillis);
         if(!closed)
             throw new Exception("~~~~");
     }
 }

  3. 의무적으로 다는 주석

    아래와 같이 javadocs를 위한 기계적인 주석은 코드만 지저분하게 만들 뿐입니다.

    아래 코드는 의무적으로 작성한 주석으로 코드 해석에 전혀 도움을 주지 않습니다.a

    심지어 CopyAndPaste 오류가 발생해 잘못된 정보를 줄 염려도 생깁니다.

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

 /**
  * 컨테이너와 관련된 Logger 구현
  */
 protected Log logger = null;

 /**
  * 컨테이너와 관련된 logger 이름
  */
 protected String logName = null;

 /**
  * 컨테이너와 관련된 Manager 구현
  */
 protected Manager manager = null;

     /**
  *
  * @param title CD 제목
  * @param author CD 저자
  */
 public addCD(String title, String author) {
     ...
 }

  4. 있으나 마나 한 주석

    당연한 사실을 언급해서 정보를 제공하지 못하는 주석은 제거하는 것이 좋습니다.

     /**
  * 기본 생성자
  */
 protected AnnualDateRule() {
 }

 /** 월 중 일자 */
 private int dayOfMonth;

 /** 
  * 월 중 일자를 반환한다.
  *
  * @return 월 중 일자
  */
 public int getDayOfMonth() {
     return dayOfMonth;
 }

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

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

  6. 닫는 괄호에 다는 주석

    닫는 괄호에 특수한 주석을 달아놓는 경우

    중첩이 심하고 장황한 함수라면 의미가 있을지도 모르겠지만, 이런 경우 함수를 작게 만들려 노력하는 편이 낫다.

     package clean.code.chapter04;

 import java.io.BufferedReader;
 import java.io.IOException;
 import java.io.InputStreamReader;

 public class wc {
   public static void main(String[] args) {
     BufferedReader in = new BufferedReader(new InputStreamReader(System.in));
     String line;
     int lineCount = 0;
     int charCount = 0;
     int wordCount = 0;
     try {
       while ((line = in.readLine()) != null) {
         lineCount++;
         charCount += line.length();
         String words[] = line.split("\\W");
         wordCount += words.length;
       } //while
       System.out.println("wordCount = " + wordCount);
       System.out.println("lineCount = " + lineCount);
       System.out.println("charCount = " + charCount);
     } // try
     catch (IOException e) {
       System.err.println("Error:" + e.getMessage());
     } //catch
   } //main
 }

  7. 이력을 기록하는 주석

    소스 파일이나 모듈 첫머리에 이력과 관련된 주석을 추가하는 경우

    버전 관리 시스템이 해주기 때문에 불필요하기 때문에 제거하는 편이 좋다.

     /**
 	 * 변경 이력 (11-Oct-2001부터)
  * -------------------------------
  * 11-Oct-2001 : 클래스를 다시 정리하고 새로운 패키지로 옮김
  * 11.Nov-2001 : getDescription() method를 추가
  */

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

    버전관리 시스템을 사용하면 필요 없는 주석입니다.

    코드에 대해 누구한테 물어볼지 알려줄 수 있어 유용할 거라 생각할 수도 있지만, 이런 주석은 오랫동안 코드에 방치되어 점차 부정확하고 쓸모없는 정보로 변할 것입니다.

     /* 2016-05-08 y.na */

  9. 주석으로 처리한 코드

    주석으로 처리된 코드는 다른 사람들도 지우기를 주저하게 되고 쓸모 없는 코드가 쌓일 위험이 있습니다.

    이유가 있어 남겨놓았으니 지우면 안된다고 생각하기 때문

    버전 관리 시스템을 믿고 지우는 것이 좋습니다.

  10. 전역 정보

    근처에 있는 코드에 대한 주석만 기술하라. 추후에 전역 정보가 변했을 때 주석을 함께 변경하는 것을 보장하기 어렵기 때문이다.

    /**
 * 적합성 테스트가 동작하는 포트: 기본값은 8082
 *
 * @param fitnessePort
 */
public void setFitnessePort(int fitnessePort) {
    this.fitnessePort = fitnessePort;
}

  11. 비공개 코드에서 Javadocs

    공개 API는 Javadocs가 유용하지만 공개하지 않을 경우에는 쓸모가 없다.
    코드가 장황해질 뿐이다.