Clean Code | 주석

목차

4장 주석

• 주석은 나쁜 코드를 보완하지 못한다
• 코드로 의도를 표현하라
• 좋은 주석
  • 법적인 주석
  • 정보를 제공하는 주석
  • 의미를 설명하는 주석
  • 의미를 명료하게 밝히는 주석
  • 결과를 경고하는 주석
  • TODO 주석
  • 중요성을 강조하는 주석
  • 공개 API에서 Javadocs
• 나쁜 주석
  • 주절거리는 주석
  • 같은 이야기를 중복하는 주석
  • 오해할 여지가 있는 주석
  • 의무적으로 다는 주석
  • 이력을 기록하는 주석
  • 있으나 마나 한 주석
  • 무서운 잡음
  • 함수나 변수로 표현할 수 있다면 주석을 달지 마라
  • 위치를 표시하는 주석
  • 닫는 괄호에 다는 주석
  • 공로를 돌리거나 저자를 표시하는 주석
  • 주석으로 처리한 코드
  • HTML주석
  • 전역 정보
  • 너무 많은 정보
  • 모호한 관계
  • 함수 헤더
  • 비공개 코드에서 Javadocs

---

나쁜 코드에 주석을 달지 마라. 새로 짜라.
- 브라이언 W. 커니헨, P.J.플라우거

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

코드에 주석을 추가하는 일반적인 이유는 코드 품질이 구리기 때문이다. 코드로 설명이 다 안되니깐 이해시키려고 달아놓은 코드들이다. 주석으로 설명하려 애쓰는 대신에 코드를 정리하자!

좋은 코드는 깔끔하고 주석이 거의 없다.

 

코드로 의도를 표현하라

확실히 코드만으로 의도를 설명하기 어려운 경우가 존재한다. 그러나 불행히도 많은 개발자가 이를 코드는 훌륭한 수단이 아니라는 의미로 해석한다.

 

아래 2개 예시 중에서 어느 쪽이 더 나은가?

아래 쪽 코드이다.

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

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

if 조건이 길고 어려워서 주석을 달아 놓은 것으로 볼 수 있다.

if (employee.isEligibleForFullBenefits())

주석을 제거하고 함수를 통해서 의도를 드러내니 주석이 없어도 충분한 표현이 가능하다.

 

좋은 주석

1. 법적인 주석

각 소스 파일 첫 머리에 들어가는 저작권 정보와 소유권 정보는 필요하고, 타당하다.

// Copyright (C) 2003, 2004, 2005 by Object Montor, Inc. All right reserved.
// GNU General Public License

실제로 내가 다니는 회사에서도 소스 코드에 대한 소유권 명시를 하지 않아 문제가 된 적이 있었다. 이러한 소유권 문제로 소스 코드 상단에 회사가 정해준 특정 주석을 반드시 추가해야하며, 이는 코드리뷰시 체크 포인트 중 하나이다.

 

2. 정보를 제공하는 주석

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

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

하지만 가능하면 함수 이름에 정보를 담거나, 클래스르 만들어 사용하는 것이 코드를 더 깔끔하게 만든다.

 

3. 의도를 설명하는 주석

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

 

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

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

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

물론 그릇된 주석을 달아놓을 위험은 상당히 높다. 왜냐하면 주석이 올바른지 검증하기 쉽지 않기 때문이다. 이것이 의미를 명료히 밝히는 주석이 필요한 이유인 동시에 주석이 위험한 이유이기도 하다. 그러므로 위와 같은 주석을 달 때는 더 나은 방법이 없는지 고민하고 정확히 달도록 각별히 주의해야 한다.

 

5.결과를 경고하는 주석

실행 결과를 미리 경고하는 주석은 괜찮은 주석이다.

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

}

 

TODO 주석

TODO 주석은 개발자가 생각하기에 필요한 부분이지만 당장 구현하기 어려운 업무를 기술하기 위해 사용한다. 

더 이상 필요 없는 기능을 삭제하라는 알림, 누군가에게 문제를 봐달라는 요청, 더 좋은 이름을 떠올려달라는 부탁, 앞으로 발생할 이벤트에 맞춰 코드를 고치라는 주의 등에 유용하다.

// TODO-MdM 현재 필요하지 않다.
// 체크아웃 모델을 도입하면 함수가 필요 없다.
protected VersionInfo makeVersion() throws Exception {
    return null;
}

대다수의 IDE는 TODO 주석을 전부 찾아 보여주는 기능을 제공하기 때문에 TODO 주석을 주기적으로 점검하여 괜찮은 주석은 없애도록 하자.

 

중요성을 강조하는 주석

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

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

 

공개 API 에서 Javadocs

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

 

 

나쁜 주석

대부분의 주석은 나쁜 주석이다.

1. 주절거리는 주석

개발자 자신만 알아듣게 작성해 놓은 주절거리는 식의 주석

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

IOException 이 발생했을 때 속성 파일이 없다는 것이고,

기본 값을 모두 메모리로 읽는다는 것은 앞으로 어떤 작업을 하겠다는 건지, 아니면 나중에 작업을 하려고 써놓은 건지 불분명하다. 따라서 로직을 다 까봐야지만 확인이 가능하다.

 

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

코드 내용을 그대로 중복하는 주석은 전혀 필요하지 않다.

// this.closed가 true일 때 반환되는 유틸
// 타임아웃에 도달하면 예외를 던짐
public synchronized void waitForClose(final long millis) throws Exception {
    if(!closed) {
        wait(millis);
        if(!closed) throw new Exception();
    }
}

 

3. 오해할 여지가 있는 주석

의도는 좋았으나, 프로그래머가 딱 맞을 정도로 엄밀하게 주석을 달지 못한 경우다. 잘못된 주석으로 프로그래머는 잘못된 코드를 작성할 수도 있다.

 

4. 의무적으로 다는 주석

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

/**
 * 
 * @param title CD 제목
 * @param author CD 저자             
 */
public void addCD(String title, String author) {
    CD cd = new CD();
    cd.title = title;
    cd.author = author;
    cds.add(cd);
}

 

5. 이력을 기록하는 주석

소스에 주석으로 이력을 관리하는 주석은 별로다. 예전에는 이력관리용 주석을 다는 것이 바람직했을지 몰라도, 현재 git 과 같은 형상관리 도구가 이력 관리를 다 해주기 때문에 이력 기록용 주석은 불필요하다.

/**
 *
 * 2021년 10월 21일 : 클래스를 정리하고 불필요한 getMember 메소드 삭제
 * 2021년 10월 25일 : getMember 메소드를 다시 추가
 * 2021년 12월 20일 : 클래스 명을 Member -> Customer로 변경
 */

 

6. 있으나 마나 한 주석

너무 당연한 사실을 언급하며 새로운 정보를 제공하지 못하는 주석이다.

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

}

나는 " // 생성자 " 와 같은 주석을 다는 습관이 있었다. 아마도 한창 개발자가 되기 위해 공부할 때 주석을 통해서 기록하고 공부하면서 생긴 나쁜 습관이었다. 지금 현업에 와서는 이런 주석이 나쁜 주석임을 깨닫고 습관을 고치는 중이다...

 

7. 무서운 잡음

때로는 Javadocs 도 잡음이다.

 

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

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

 

9. 위치를 표시하는 주석

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

극히 드물지만 위와 같은 배너 아래 특정 기능을 모아놓으면 유용한 경우도 있긴 하다. 하지만 일반적으로 위와 같은 주석은 가독성만 낮추므로 제거해야 마땅하다.

배너는 반드시 필요할 때만, 아주 드물게 사용하는 편이 좋다. 배너를 남용하면 흔한 잡음으로 여겨 무시하게 되기 때문이다.

 

10. 닫는 괄호에 다는 주석

for(int i=0;i<10;i++)
{
		....
        
} // end for

중첩이 심하고 장황한 함수를 사용하게 될 때 닫는 괄호에 주석을 달기도 한다. 하지만 이는 잡음일 뿐이다.

닫는 괄호에 주석을 달아야겠다는 생각이 든다면 함수를 줄이려는 시도를 하자.

 

나는 현업에서 이런 주석을 사용한 경험이 꽤 있어서 뜨끔했다. 😅 

for 문과  if문의 중첩이 너무 많아서 닫는 괄호를 구분해야 마음이 편했었는데, 이제는 그런 중첩문들을 없애는 리팩토링을 하는 노력을 기울여야겠다고 생각했다.

 

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

우리에게는 Git 과 같은 소스코드 형상관리 tool이 있다. 이제 이런 주석은 없애자!

/*
	케빈이 추가한 함수
*/

 

12. 주석으로 처리한 코드

이제는 쓸모 없어진, 아니면 디버깅을 위해 처리한? 주석들이다.

도대체 무슨 의미로 주석을 남겼는지 알 수 없는 코드는 괜한 오해만 생기게 한다.

그리고 주석으로 처리된 코드는 다른 사람들이 지우기를 주저한다. 이유가 있어 남겨놓았으리라고 생각하여 지우면 안될 것 같다고 생각한다. 그래서 질 나쁜 와인병 바닥에 앙금이 쌓이듯 쓸모없는 코드가 점차 쌓여간다.

return getMember();
 
// updateMember();
// return member;

또 강조하지만, 우리에게는 Git 과 같은 소스코드 형상관리 tool이 있다. 이제 이런 주석은 없애자!

 

13. 전역 정보

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

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

 

14. 너무 많은 정보

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

 

15. 함수 헤더

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

 

16. 비공개 코드에서 Javadocs

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

 

이 내용은 로버트 C.마틴 의 『Clean Code』 를 보고 정리하였습니다.