[Clean Code] Ch.4 주석

 

• 부정확한 주석은 아예 없는 주석보다 훨씬 더 나쁘다
• 주석이 필요 없는 방향으로 에너지를 쏟자
• 상황을 역전해 코드로 의도를 표현할 방법은 없을까?
  • 코드로 의도를 표현하자

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

if (employee.isEligibleForFullBenefits())

• 주석은 나쁜 코드를 보완하지 못한다
  • 주석을 추가하는 일반적인 이유는 코드 품질이 나쁘기 때문 → 코드를 정리하자

 

  좋은 주석

• 정말 좋은 주석이라는 의미 x. 글자 값을 하는 주석
• 정말로 좋은 주석은 주석을 달지 않을 방법을 찾아낸 주석

 

법적인 주석

• 첫머리에 주석으로 들어가는 저작권 정보, 소유권 정보

// Copyright (C) 2003,2004,2005 by Object Mentor, Inc. All rights reserved

 

정보를 제공하는 주석

• ex) 메서드가 반환할 값을 설명, 정규표현식의 의미

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

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

의도를 설명하는 주석

• 결정에 깔린 의도를 설명

// 스레드를 대량 생성하는 방법으로 어떻게든 경쟁 조건을 만들려 시도한다.
for (int i = 0; i < 25000; i++){
    WidgetBuilderThread widgetBuilderThread =
        new WidgetBuilderThread(widgetBuilder, text, parent, fallFlag);
    Thread thread = new Thread(widgetBuilderThread);
    thread.start();
}

 

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

• 인수나 반환값이 표준 라이브러리이거나 변경하지 못하는 경우 의미를 명료하게 밝히는 주석이 유용
• 다만, 이 경우 검증하기 어려우므로 각별한 주의 필요

assertTrue(a.compareTo(a) == 0); // a == a
assertTrue(a.compareTo(b) != 0); // a != b
assertTrue(aa.compareTo(ab) == -1); // aa < ab

 

결과를 경고하는 주석

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

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

• 요즘엔 @ignore 속성을 이용해 테스트 케이스를 꺼버림 (golang에서는 skip 사용)

 

TODO 주석

• 앞으로 할 일을 TODO 주석으로 남겨두면 편함
• 다만, 주기적으로 TODO 주석을 점검하여 없앨 수 있는 주석은 없애는게 좋음

 

중요성을 강조하는 주석

• 코드상에서 중요성이 나타나지 않는 중요성을 강조하는 경우 주석을 사용

 

공개 API 에서의 docs

• 공개 API를 구현한다면 반드시 훌륭한 docs를 작성해야 함

 

 

  나쁜 주석

• 대다수 주석이 나쁜 주석

 

주절거리는 주석

• 특별한 이유 없이 의무감으로 마지못해 단 주석

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

• IOException이 발생하면 속성 파일이 없다는 뜻 
  • 어떤 함수가 모든 기본값을 읽어 들이는지? 알 수 없음

 

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

• 주석이 같은 코드 내용을 그대로 중복하는 경우
• 주석이 코드보다 더 많은 정보를 제공하지 못함

// 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로 변하는 순간에 메서드가 반환되는 것이 아님. 

 

의무적으로 다는 주석

• 모든 함수에 docs를 달거나 모든 변수에 주석을 달아야 한다는 규칙은 어리석은 규칙
• 오히려 코드를 헷갈리게 만들고, 잘못된 정보를 작성할 여지만 만듦

 

이력을 기록하는 주석 or 공로를 돌리거나 저자를 표시하는 주석

• 예전에는 모든 모듈의 첫머리에 변경 이력을 기록하고 관리하는 관례 존재
• 지금은 소스 코드 관리 시스템(ex. Git)이 있기 때문에 필요 없음

 

있으나 마나 한 주석

• 너무 당연한 사실을 언급하며 새로운 정보를 제공하지 못하는 주석
• 많이 사용하면 개발자가 주석을 무시하는 습관에 빠짐

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

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

/** The name. */
private String name;

/** The licenseName. */
private String licenceName;

 

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

 

• Bad

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

• Good

ArrayList moduleDependees = smodule.getDependSubsystems();
String ourSubSystem = subSysMod.getSubSystem();
if (moduleDependees.contains(ourSubSystem))

 

위치를 표시하는 주석

• 특정 위치를 표시하기 위해 사용하는 주석
• 아래와 같은 배너 아래 특정 기능을 모아놓으면 유용한 경우가 있긴 하지만, 가독성을 낮추므로 제거하는 것이 좋음
• 반드시 필요할 때만 아주 드물게 사용

// Actions ////////////////////////////

 

 

닫는 괄호에 다는 주석

• 중첩이 심하고 장황한 함수라면 의미가 있긴 함 → 함수를 줄이자

...
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

 

주석으로 처리한 코드

• 주석으로 처리된 코드는 다른 사람들이 지우기를 주저함 → 점점 쌓여감
• 소스 코드 관리 시스템이 코드를 기억해줌

 

HTML 주석

• 웹 페이지에 올리는 경우, 주석에 HTML 태그를 삽입해야 하는 책임은 프로그래머가 아니라 도구가 책임져야 함.

 

전역 정보

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

 

너무 많은 정보

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

 

모호한 관계

• 주석과 주석이 설명하는 코드는 둘 사이의 관계가 명확해야 함
• 필터 바이트?

/*
 * 모든 픽셀을 담을 만큼 충분한 배열로 시작한다(여기에 필터 바이트를 더한다).
 * 그리고 헤더 정보를 위해 200바이트를 더한다.
 */
this.pngBytes = new byte[((this.width + 1) * this.height * 3) + 200];

 

함수 헤더

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

 

비공개 코드에서 Javadocs

• 공개하지 않을 코드라면 Javadocs는 쓸모가 없다.