[CleanCode] -4. 주석

📌 전체 내용을 관통하는 문장

'나쁜 코드에 주석을 달지 마라. 새로 짜라'

• 브라이언 W. 커니핸,P.J. 플라우거

• 주석이 필요한 상황에 처하면 곰곰이 생각해보고 코드로 의도를 표현할 수 있는 방법이 없을지 고민해보기

1. 주석을 무시하는 이유

• 프로그래머들이 주석을 유지하고 보수하기란 현실적으로 불가능하기 때문에,
  • 주석은 오래될수록 코드에서 멀어진다.
  • 오래될 수록 완전히 그릇될 가능성도 커진다.

• 부정확한 주석은 아예 없는 주석보다 훨씬 더 나쁘다.
• 그렇기 때문에 우리는 간혹 필요할지라도 주석을 가능한 줄이도록 꾸준히 노력해야 한다.

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

• 자신이 저지른 난장판을 주석으로 설명하려고 애쓸 시간에 코드를 정리해라

3. 코드로 의도를 표현하라

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


[개선된 코드]
if employee.isEligibleForFullBenefits()

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

4. 좋은 주석

• 어떤 주석은 필요하거나 유익하다.

• 법적인 주석: 저작권 정보, 소유권 정보
• 정보를 제공하는 주석

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

• 의도를 설명하는 주석: 구현을 설명하는 것을 넘어, 결정에 깔린 의도까지 설명한다.
• 의미를 명료하게 밝히는 주석: 변수, 함수의 이름 자체를 명확하게 만들면 좋겠지만, 표준 라이브러리나 변경하지 못하는 코드를 다루는 경우
• 결과를 경고하는 주석
  ex) Thread-safe 하지 않기 때문에 인스턴스를 독립적으로 생성해야 한다
• TODO 주석: 필요하다고 여기지만 당장 구현하기 어려운 업무 기술
• 중요성을 강조하는 주석: 자칫 대수롭지 않다고 여겨질 뭔가의 중요성을 강조하기 위한 주석

// 여기서 trim 은 정말 중요하다. trim 함수는 문자열에서 앞, 뒤 공백을 제거한다.
// 문자열 앞, 뒤에 공백이 있으면 다른 문자열로 인식되기 때문이다.
let listItemContent = match.group(3).trimmingCharacters(in: [" "])

• 공개 API

5. 나쁜 주석

대다수 주석이 이 범주에 속한다.

• 주절거리는 주석: 본인만 알아들을 수 있는 주석, 이해하려면 다른 코드를 뒤져봐야 하는 주석
• 같은 이야기를 중복하는 주석: 코드 내용을 서술하기만 하여 코드보다 읽고 이해하는 시간이 더 오래 걸리는 주석
• 오해할 여지가 있는 주석
• 이력을 기록하는 주석: 지금은 소스 관리 시스템이 있는 관계로 필요 없음
• 있으나 마나 한 주석: 이러한 주석이 반복되면 읽는 프로그래머가 주석을 점점 무시하게 됨

// 월 중 일자
private let dayOfMonth: Int

• 함수나 변수로 표현할 수 있다면 주석을 달지 마라: 주석이 필요하지 않도록 코드 개선

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

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

let moduleDependencies = smodule.getDependSubSystems()
let ourSubSystem = subSysMod.getSubSystem()
if moduleDependencies.contains(ourSubSystem)

• 위치를 표시하는 주석: 가독성을 낮추므로 제거해야 마땅

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

• 닫는 괄호에 다는 주석: 중첩이 심하고 장황한 함수라면 의미가 있을지도 모르지만, 우리가 선호하는 작고 캡슐화된 함수에는 잡음일 뿐임.
  따라서 만약 닫는 괄호에 주석을 달 생각이 든다면 함수를 줄이려 시도

• 주석으로 처리한 코드: 무언가 이유가 있으니깐 주석 처리를 한게 아닐까 싶어 다른 사람들이 지우기를 주저하게 만든다.

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

• 너무 많은 정보
  주석에다 흥미로운 역사, 관련 없는 정보를 장황하게 늘어놓지 마라
  ex) RFC 2045 의 역사

• 모호한 관계
  : 코드에 대한 설명이 부족한 주석

/*
모든 픽셀을 담을 만큼 충분한 배열로 시작한다(여기에 필터 바이트를 더한다).
그리고 헤더 정보를 위해 200바이트를 더한다.
*/
self.pngBytes = new byte[(self.width + 1) * self.height * 3) + 200]

여기에서 필터 바이트란 무엇일까? 1이랑 관련이 있는건지? 아니면 *3이랑 관련이 있는건지?
그렇다면 200을 추가하는 이유는 ?
-> 주석을 다는 목적은 코드만으로 설명이 부족해서인데, 이 코드는 주석 자체가 다시 설명을 요구한다.

결론

개인적인 결론

결국 맨 앞 장에서 나오는 문장 하나로 모든 내용의 정리가 가능하다고 생각한다.

'나쁜 코드에 주석을 달지 마라. 새로 짜라'

• 브라이언 W. 커니핸,P.J. 플라우거

과연 이 코드가 이해가 될 것인가? 고민해보고
그렇지 않다면 코드로 최대한 의도를 표현하고자 노력한 후
마지막 수단으로 주석을 사용해야 하지 않을까 생각한다.