Clean Code 4장 - 주석

2021년 2월 8일 Commit

• 주석은 나쁜 코드를 보완하지 못한다
• 코드로 의도를 표현하라
• 좋은 주석
• 나쁜 주석

개요

• 잘 달린 주석은 그 어떤 정보보다 유용하다.
• 경솔하고 근거 없는 주석은 코드를 이해하기 어렵게 만든다.
• 우리는 코드로 의도를 표현하지 못해, 그러니까 실패를 만회하기 위해 주석을 사용한다.
• 주석은 실패를 의미한다.
• 주석이 필요한 상황에 처했다면, 상황을 역전시켜 코드로 의도를 표현할 방법은 없을까?
• 주석은 오래될수록 코드에서 멀어지고 그릇될 가능성도 커진다. (프로그래머들이 주석을 유지하고 보수하기란 현실적으로 불가능하니까)
• 부정확한 주석은 아예 없는 주석보다 훨씬 더 나쁘다.
• 부정확한 주석은 독자를 현혹하고 오도한다.
• 진실은 한곳에만 존재한다. 바로 코드다. 코드만이 자기가 하는 일을 진실되게 말한다.
• 코드만이 정확한 정보를 제공하는 유일한 출처다.
• (간혹 필요할지라도) 주석을 가능한 줄이도록 꾸준히 노력해야 한다.

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

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

코드로 의도를 표현하라!

• 코드만으로 의도를 설명하기 어려운 경우가 존재한다.

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

if (employee.isEligibleForFullBenefits()) {}

• 몇 초만 더 생각하면 코드로 대다수 의도를 표현할 수 있다.
• 많은 경우 주석으로 달리는 설명을 함수로 만들어 표현해도 충분하다.

좋은 주석

• 주석을 달지 않을 방법을 찾아낸 주석이 좋은 주석이다?!

법적인 주석

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

정보를 제공하는 주석

• 때로는 기본적인 정보를 주석으로 제공하면 편리하다. 그래도 가능하다면 함수 이름에 정보를 담는 편이 더 좋다.
• 정규표현식에 대한 주석
  • 그래도 이왕이면 시각과 날짜를 변환하는 클래스를 반들어 코드를 옮겨주면 더 좋고 깔끔해지고 주석이 필요없어진다.

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

의도를 설명하는 주석

• 때때로 주석은 구현을 이해하게 도와주는 선을 넘어 결정에 깔린 의도까지 설명한다.
• 쉽게 말하면 왜 이 로직을 사용하고 있는지 그 해결한 방식에 대한 주석

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

• 인수나 반환값이 표준 라이브러리나 변경하지 못하는 코드에 속한다면 의미를 명료하게 밝히는 주석이 유용하다.
• 주석이 올바른지 검증하기 쉽지 않은만큼 의미를 명료히 밝히는 주석이 필요한 이유인 동시에 주석이 위험하기도 하다.

결과를 경고하는 주석

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

TODO 주석

• '앞으로 할 일'을 // TODO 주석으로 남겨두면 편하다.

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

• 요즘 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 역시 독자를 오도하거나, 잘못 위치하거나, 그릇된 정보를 전달할 가능성이 존재한다.

나쁜 주석

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

주절거리는 주석

• 특별한 이유 없이 의무감으로 혹은 프로세스에서 하라고 하니까 마지못해 주석을 단다면 전적으로 시간낭비다.

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

• 헤더에 달린 주석이 같은 코드 내용을 그대로 중복하는 경우

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

오해할 여지가 있는 주석

• 때때로 의도는 좋았으나 프로그래머가 딱 맞을 정도로 엄밀하게는 주석을 달지 못하기도 한다.
• 주석에 담긴 '살짝 잘못된 정보'로 인해 프로그래머가 골머리를 앓을 수도 있다.

의무적으로 다는 주석

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

있으나 마나 한 주석

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

무서운 잡음

• 때로는 Javadocs도 잡음이다.
• 단지 문서를 제공하기 위해 불필요한 잡음을 넣지 말자

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

위치를 표시하는 주석

• 배너 아래 특정 기능을 모아 유용한 경우도 있긴 하다.
• 일반적으로는 가독성만 낮추므로 제거해야 마땅하다.

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

닫는 괄호에 다는 주석

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

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

• 소스 코드 관리 시스템은 누가 언제 무엇을 추가했는지 귀신처럼 기억한다.
• 저자 이름으로 코드를 오염시킬 필요가 없다.
• 누가 수정했는지 알아서 유용할지도 모른다? -> 현실적으로 그냥 오랫동안 코드에 방치되어 점차 부정확하고 쓸모없는 정보로 변하기 쉽다.
• 이런 정보는 소스 코드 관리 시스템에 저장하는 편이 좋다.

주석으로 처리한 코드

• 주석으로 처리된 코드는 다른 사람들이 지우기를 주저한다.
• 이유가 있어서 남겨놓았고, 중요하니까 지우면 안되는줄 알아서 그렇다.
• 그래서 점점 쓸모 없는 코드가 쌓이게 된다.
• 소스 코드 관리 시스템이 우리의 기억을 대신해준다.

HTML 주석

• 혐오 그 자체다..

전역 정보

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

너무 많은 정보

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

모호한 관계

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

함수 헤더

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

비공개 코드에서 Javadocs

• 공개하지 않을 코드라면 쓸모 없다.
• 코드만 보기 싫고 산만해진다.