이 글은 "Clean Code(클린 코드) 애자일 소프트웨어 장인 정신" 을 읽고 공부한 내용을 기반으로 작성한 글입니다.

---

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

프로그래밍 언어 자체가 표현력이 풍부하다면, 우리에게 피로그래밍 언어를 치밀하게 사용해 의도를 표현할 능력이 있다면, 주석은 거의 필요하지 않다.

주석은 필요악.

코드로 의도를 표현하지 못해, 실패를 만회하기 위해 주석을 사용한다.

주석을 무시하는 이유 ▶️ 주석이 오래될수록 코드에서 멀어져 완전히 그릇될 가능성이 커진다.
주석을 유지하고 보수하기엔 현실적으로 불가능하다.

---

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

코드에 주석을 추가하는 일반적인 이유 ▶️ 코드의 품질이 나빠서

표현력이 풍부하고 깔끔하며 주석이 거의 없는 코드가 복잡하고 어수선하며 주석이 많이 달린 코드보다 훨씬 좋다.

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

---

코드로 의도를 표현하라!

>>나쁜 예

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

>>좋은 예

if (employee.isEligibleForFullBenefits())

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

---

😀좋은 주석

어떤 주석은 필요하거나 유익하다.
하지만 정말 좋은 주석은, 주석을 달지 않을 방법을 찾아낸 주석

📍법적인 주석

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

// Copyright (C) 2003,2004,2005 by ...
//GNU General Public License

📍정보를 제공하는 주석

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

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

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

📍의도를 설명하는 주석

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

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

모호한 인수나 반환값은 그 의미를 읽기 좋게 표현하면 이해하기 쉬워진다.
인수나 반환값이 표준 라이브러리나 변경하지 못하는 코드에 속한다면 의미를 명료하게 밝히는 주석이 유용하다.
→ but 그릇된 주석을 달아놓을 위험이 상당히 높다.

📍결과를 경고하는 주석

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

📍TODO 주석

앞으로의 할 일을 //TODO 주석으로 남겨두면 편하다.
TODO 주석은 프로그래머가 필요하다 여기지만 당장 구현하기 어려운 업무를 기술한다.
더 이상 필요 없는 기능을 삭제하라는 알림, 누군가에게 문제를 봐달라는 요청, 더 좋은 이름을 떠올려달라는 부탁, 앞으로 발생할 이벤트에 맞춰 코드를 고치라는 주의 등에 유용하다.

요즘 나오는 대다수 IDE는 TODO 주석 전부를 찾아 보여주는 기능을 제공하므로 잊어버릴 염려가 없다.

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

📍중요성을 강조하는 주석

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

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

📍공개 API에서 Javadocs

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

---

😠나쁜 주석

대다수 주석이 이 범주에 속한다.
일반적으로 대다수 주석은 허술한 코드를 지탱하거나, 엉성한 코드를 변명하거나, 미숙한 결정을 합리화하는 등 프로그래머가 주절거리는 독백에서 크게 벗어나지 못한다.

☔주절거리는 주석

특별한 이유 없이 의무감으로 혹은 프로세스에서 하라고 하니까 마지못해 주석을 다는 것.
이해가 안되어 다른 모듈까지 뒤져야 하는 주석은 독자와 제대로 소통하지 못하는 주석이다.

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

헤더에 달린 주석이 같은 코드 내용을 그대로 중복한다.
코드보다 주석을 읽는 시간이 더 오래 걸릴 수 있다.

// 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");
        }
    }
}

☔오해할 여지가 있는 주석

의도는 좋았으나 프로그래머가 딱 맞을 정도로 엄밀하게는 주석을 달지 못하기도 한다.

☔의무적으로 다는 주석

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

/**
 *
 * @param title CD 제목
 * @param author CD 저자
 * @param tracks CD 트랙 숫자
 * @param durationInMinutes CD 길이(단위: 분)
 */

☔이력을 기록하는 주석

소스 코드 관리 시스템이 있으므로 이력을 기록하는 로그 주석은 혼란만 가중할 뿐 완전히 제거하는 것이 좋다.

* 변경 이력 (11-Oct-2001부터)
* --------------------------
* 11-Oct-2001 : 클래스를 다시 정리하고
..

☔있으나 마나 한 주석

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

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

☔무서운 잡음

때로는 Javadocs도 잡음이다.

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

>>주석을 제거하기 전

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

>>주석을 제거한 표현

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

☔위치를 표시하는 주석

소스 파일에서 특정 위치를 표시하려 주석을 사용한다.

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

이런 주석은 가독성만 낮추므로 제거해야 마땅하다. 특히 뒷부분에 슬래시(/)로 이어지는 잡음은 제거하는 편이 좋다.

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

☔닫는 괄호에 다는 주석

중첩이 심하고 장황한 함수라면 의미가 있을지도 모르지만 작고 캡슐화된 함수에는 잡음일 뿐이다. 그러므로 닫는 괄호에 주석을 달아야겠다는 생삭이 든다면 대신에 함수를 줄이려 시도하자.

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

/* 릭이 추가함 */

소스 코드 관리 시스템은 누가 언제 무엇을 추가했는지 기억한다.
저자 이름으로 코드를 오염시킬 필요가 없다.

☔주석으로 처리한 코드

this.bytePos = writeBytes(pngIdBytes, 0);
//hdrPos = bytePos;
writeHeader();
writeResolution();
//dataPos = bytePos;
...

소스 과리 시스템이 우리를 대신해 코드를 기억해준다. 이제는 주석으로 처리할 필요가 없다. 그냥 코드를 삭제하라. 잃어버릴 염려는 없다. 약속한다.

☔HTML 주석

소스 코드에서 HTML 주석은 혐오 그 자체. 읽기 어려움

☔전역 정보

주석을 달아야 한다면 근처에 있는 코드만 기술하라.
코드 일부에 주석을 달면셔 시스템의 전반적인 정보를 기술하지 마라.
포트 기본값을 설정하는 코드가 변해도 아래 주석이 변하리라는 보장은 전혀 없다.

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

☔너무 많은 정보

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

☔모호한 관계

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

☔함수 헤더

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

☔비공개 코드에서 Javadocs

공개 API는 Javadocs가 유용하지만 공개하지 않을 코드라면 Javadocs는 쓸모가 없다.
유용하지 않으며 코드만 보기 싫고 산만해질 뿐이다.

---

Reviews

코드를 작성하다가 만약을 핑계로 쓸 필요가 없는 코드를 주석으로 자주 넣기도 했다. 내용만 차지하고 쓸모 없는 코드를 주절거리며 혼자 합리화했을지도 모른다...😏 4장 주석 부분의 내용을 읽으면서 좋은 주석과 나쁜 주석을 분류할 수 있게 된 것 같다. 주석으로 표현하기 전에 먼저 코드를 확인하고 코드로 구현할 수 있다면 더할 나위 없이 깨끗한 코드가 만들어지겠지? 더 나은 코드로 개선되는 그날까지...♾️