[Clean Code] 4장 주석

잘 달린 주석은 어떤 정보보다 유용하지만 나쁜 주석은 코드를 이해하기 어렵게 만든다.

 

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

코드에 주석을 추가하는 일반적인 이유는 코드 품질이 나쁘기 때문이다.

표현력이 풍부하고 깔끔하며 주석이 거의 없는 코드가 훨씬 좋다.

 

코드로 의도를 표현하라

많은 경우 주석으로 달려는 설명을 함수로 만들어 표현해도 충분하다.

 

 

코드의 의도를 표현하라

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

 

이런코드가 아닌

if (employee.isEligibleForFuUBenefits())

몇초만 더 생각하면 대다수의 의도를 표현 가능하다.

 

1. 좋은 주석

• 법적인 주석: 회사가 정립한 구현 표준에 맞춰 법적인 이유로 넣는다. Ex) 저작권, 소유권 등
• 정보를 제공하는 주석: 기본적인 정보를 주석으로 제공하면 편리하다. Ex) 반환값 등
• 의도를 설명하는 주석: 구현을 이해하게 도와주는 선을 넘어 결정에 깔린 의도까지 설명한다.
• 의미를 명료하게 밝히는 주석: 모호한 인수나 반환값은 그 의미를 읽기 좋게 표현하면 이해하기 쉬워진다.

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

assertTrue(a.compareTo(a) == 0) ； // a == a

• 결과를 경고하는 주석: 다른 프로그래머에게 결과를 경고한다.
• TODO 주석: 필요하다 여기지만 당장 구현하기 어려운 업무를 기술한다.
• 중요성을 강조하는 주석: 대수롭지 않다고 여겨질 뭔가의 중요성을 강조하기 위해 사용한다.

String listltemContent = match.group(3).trim();
// 여기서 trim은 정말 중요하다. trim 함수는 문자열에서 시작 공백을 제거한다.
// 문자열에 시작 공백이 있으면 다른 문자열로 인식되기 때문이다.
new ListltemWidget(this,listltemContent, this.level + 1);
return buildList(text.substring(match.end()));

 

2. 나쁜 주석

• 주절거리는 주석: 이해가 안 돼 다른 모듈까지 봐야 한다면 제대로 소통하지 못하는 주석이다.
• 같은 이야기를 중복하는 주석: 주석이 같은 코드 내용을 그대로 중복한다.

   ※ 아래와 같은 주석을 달은 목적은 무엇이며 이 주석은 코드보다 더 좋은 정보를 제공하지 못한다.

//this .closed 가 true 일 때 반환되는 유틸리티 메서드다.
//타임아웃에 도달하면 예외를 던진다.
public synchronized void waitForClose(finaI long timeoutMillis)
        throws Exception {
    if (!closed) {
        wait(timeoutMillis);
        if (!closed)
            throw new Exception("MockResponseSender could not be closed");
    }
}

• 오해할 여지가 있는 주석
• 의무적으로 다는 주석
• 이력을 기록하는 주석
• 함수나 변수로 표현할 수 있다면 주석을 달지 마라
• 위치를 표시하는 주석: 소스 파일에서 특정 위치를 표시하려 사용하는 주석은 아주 드물게 사용하는 편이 좋다. Ex) 긴 슬래시
• 닫는 괄호에 다는 주석
• 주석으로 처리한 코드
• 전역 정보: 코드 일부에 주석을 달면서 시스템의 전반적인 정보를 기술하지 말아야 한다. 근처에 있는 코드만 기술하는 것이 좋다.
• 너무 많은 정보
• 무서운 잡음

/** The name. */
private String name;
/** The version. */
private String version;
/** The licenceName. */
private String licenceName;
/** The version. */
private String info;

실제 저자가 어디서 가져온 코드와 주석인데 마지막 부분에 심지어 잘라넣기를 해서 version이라는 주석을 넣었다

이런 주석은 이익을 얻을만한 내용이 없다.