클린코드 4장 - 주석

클린코드를 읽고 요약정리한 내용입니다

---

4장 - 주석

잘 달린 주석은 그 어떤 정보보다 유용하다. 하지만 근거없는 주석은 코드를 이해하기 어렵게 만든다.

주석은 순수하게 선하지 못하다.

우리는 코드로 의도를 표현하지 못해 주석을 사용하게 된다. 프로그래밍 언어를 치밀하게 사용해 의도를 표현할 능력이 있다면

주석은 전혀 필요하지 않다.

주석은 오래될수록 코드에서 멀어진다. 주석을 관리하고 유지보수하기란 실질적으로 불가능하기 때문이다.

부정확한 주석은 아예 없는 주석보다 훨씬 더 나쁘다.

그러므로 우리는 주석을 가능한 줄이도록 꾸준히 노력해야한다.

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

• 주석을 추가하는 일반적인 이유는 코드 품질이 나쁘기 때문
• 자신이 저지른 난장판을 주석으로 설명하느라 애쓰는 대신 난장판을 깨끗이 치우는데 시간을 보내라.

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

몇 초만 더 생각하면 코드로 대다수의 의도를 표현할 수 있다.

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

3. 좋은 주석

어떠한 주석은 필요하거나 유익하다.

법적인 주석

회사가 정립한 구현 표준에 맞춰 법적인 이유료 특정 주석을 넣으라고 명시하는 경우가 있다.

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

정보를 제공하는 주석

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

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

하지만 함수 이름에 정보를 담는 편이 더 좋다.

protected abstract Responder responderBeingTested();

사용한 정규표현식을 뜻하는 주석도 있다.

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

하지만 이왕이면 시각과 날짜를 변환하는 클래스를 만들어 코드를 옮겨주면 더 좋고 깔끔해진다. 그러면 주석이 필요 없어진다.

의도를 설명하는 주석

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

저자가 문제를 해결한 방식에 동의하지 않을지도 모르지만 어쨌거나 저자의 의도는 분명히 드러난다.

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

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

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

하지만 주석이 올바른지 검증하기 쉽지 않기 때문에 의미를 명료히 밝히는 주석이 필요함과 동시에 위험한 이유가 된다.

결과를 경고하는 주석

떄로 다른 프로그래머에게 결과를 경고할 목적으로 주석을 사용한다. ex) 특정 테스트 케이스를 꺼야하는 이유를 설명하는 주석

TODO 주석

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

하지만 어떤 용도로든 시스템에 나쁜 코드를 남겨 놓는 핑계가 되어서는 안된다. 주기적으로 TODO 주석을 점검해 없애도 괜찮은 주석이라면 없애도록 한다.

중요성을 강조하는 주석

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

공개 API에서 Javadocs

설명이 잘 된 공개 API는 유용하다. 표준 라이브러리에서 사용한 Javadocs가 좋은 예이다.

하지만 여느 주석과 마찬가지로 Javadocs 역시 독자를 오도하거나, 잘못 위치하거나, 그릇된 정보를 전달할 가능성이 존재한다.

4. 나쁜 주석.

• 대다수의 주석은 허술한 코드를 지탱하거나
• 엉성한 코드를 변명하거나
• 미숙한 결정을 합리화하는 등 프로그래머의 독백에서 크게 벗어나지 못한다.

주절거리는 주석

주석을 달기로 결정했다면 충분한 시간을 들여 최고의 주석을 달도록 노력한다.

독자와 제대로 소통하지 못하는 주석은 바이트만 낭비할 뿐이다.

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

주석이 같은 코드 내용을 그대로 중복하는 경우가 있다.

// 유저 인덱스를 통해 유저를 찾는다
public User findUserByUserIdx(long userIdx);

코드보다 부정확한 주석은 독자가 함수를 대충 이해하고 넘어가게 만든다.

오해할 여지가 있는 주석

의도는 좋았으나 딱 맞을 정도로 엄밀하게 주석을 달지 못하는 경우가 있다.

이러한 경우 주석에 담긴 살짝 잘못된 정보 로 인해 다른 프로그래머에게 혼란을 야기할 수 있다.

의무적으로 다는 주석

모든 함수에 Javadoc를 달거나 모둔 변수에 주석을 달아야 한다는 규칙은 어리석기 그지없다.

이러한 주석은 코드를 복잡하게 만들고, 거짓말을 퍼뜨려 혼돈과 무질서를 초래하게 된다.

이력을 기록하는 주석

과거에는 모든 모듈 첫머리에 변경 이력을 기록하고 관리하는 관례가 바람직했지만 요즘에는 소스 코드 관리 시스템이 있기 때문에 이러한 주석은 제거하는 편이 좋다.

있으나 마나 한 주석

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

이와 같은 주석은 개발자가 주석을 무시하는 습관에 빠지게 만든다.

있으나 마나 한 주석을 달려는 유혹에서 벗어나 코드를 정리하라.

무서운 잡음

때로는 Javadocs도 잡음이다.

지나치고 의미없는 Javadocs는 단지 문서를 제공해야 한다는 잘못된 욕심으로 탄생한 잡음일 뿐이다.

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

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

이 코드에서 주석을 없애고 다시 표현하면 다음과 같다.

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

위치를 표시하는 주석

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

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

닫는 괄호에 주석

닫는 괄호에 특수한 주석을 달아 놓는다.

if () {
    while() {

    } // while
} // if

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

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

소스 코드 관리 시스템은 주가 언제 무엇을 추가했는지 귀신처럼 기억한다.

그러므로 저자 이름으로 코드를 오염시킬 필요는 없다.

주석으로 처리한 코드

주석으로 처리한 코드만큼 밉살스러운 관행도 드물다.

주석으로 처리된 코드는 다른 사람들이 지우기를 주저하게 된다.

소스 코드 관리 시스템이 우리를 대신해 코드를 기억해주기 때문에 우리는 코드를 주석으로 처리할 필요가 없다.

HTML 주석

Javadoc와 같은 도구로 주석을 뽑아 웹 페이지에 올릴 작정이라면 주석에 HTML태그를 삽입해야 하는 책임은 프로그래머가 아니라 도구가 져야한다.

전역 정보

주석을 달아야한다면 근처에 있는 코드만 기술해야한다.

코드 일부에 주석을 달면서 시스템의 전반적인 정보를 기술하지 마라.

너무 많은 정보

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

독자에게 불필요하며 불가사의한 정보일 뿐이다.

모호한 관계

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

이왕 공들여 주석을 달았다면 적어도 독자가 주석과 코드를 읽고 무슨 소리인지 알아야 한다.

함수 헤더

짧은 함수는 긴 설명이 필요없다.

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

비공개 코드에서 Javadocs

공개하지 않을 코드라면 Javadocs를 생성할 필요는 없다.