클린 코드 책 커버

#노마드코더 #북클럽 #노개북

내용 요약(Notion)

TIL (Today I Learned)

좋은 주석과 나쁜 주석에 대해 알아보았다. 일반적으로 주석은 필요하지 않는 경우가 많다.

오늘 읽은 범위

4장. 주석

책에서 기억하고 싶은 내용을 써보세요.

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

-브라이언 W. 커니헨, P.j.플라우거

저자

주석은 기껏해야 필요악이다.

우리는 코드로 의도를 표현하지 못해 주석을 사용한다.

주석을 달 때마다 자신에게 표현력이 없다는 사실을 푸념해야 마땅하다.

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

코드에 주석을 추가하는 일반적인 이유는 코드 품질이 나쁘기 때문이다.

코드로 의도를 표현하라!

// 직원에게 복지 혜택을 받을 자격이 있는지 검사
if ((employee.flogs & 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*"
);

위 코드의 주석은 코드에서 사용한 정규표현식이 시각과 날짜를 뜻한다고 설명한다.

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

의도를 설명하는 주석

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

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

  • 모호한 인수나 반환값은 그 의미를 읽기 좋게 표현하면 이해하기 쉬워진다
  • 인수나 반환값이 표준 라이브러리나 변경하지 못하는 코드에 속한다면 의미를 명료하게 밝히는 주석이 유용하다.

결과를 경고하는 주석

// 여유 시간이 충분하지 않다면 실행하지 마십시오.
public void_testWithReeallyBigFile() {
    writeLinesToFile(100000000);
    ...
}

TODO 주석

  • 앞으로 할 일을 //TODO 주석으로 남겨두면 편하다.
  • 주기적으로 //TODO 주석을 점검해 없애도 괜찮은 주석은 없애라.

중요성을 강조하는 주석

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

공개 API에서 Javadocs

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

나쁜 주석

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

주절거리는 주석

  • 특별한 이유 없이 의무감으로 남기는 주석
  • 프로세스에서 하라고 하니까 마지못해 남기는 주석

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

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

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

오해할 여지가 있는 주석

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

의무적으로 다는 주석

의무적으로 다는 주석 예제

이력을 기록하는 주석

이력을 기록하는 주석 예제

  • 때때로 사람들은 모듈을 편집할 때마다 모듈 첫머리에 주석을 추가한다.
  • 모듈 첫머리 주석은 지금까지 모듈에 가한 변경을 모두 기록하는 일종의 일지 혹은 로그가 된다.
  • 과거에는 이러한 관례가 바람직했다.
  • 현재는 소스 코드 관리 시스템이 있기 때문에 필요 없다.

있으나 마나 한 주석

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

/** 월 중 일자 */
private int dayOfMonth;

무서운 잡음

무서운 잡음 예제

위 코드는 잘 알려진 오픈 소스 라이브러리에서 가져온 코드다. 위 Javadocs는 어떤 목적을 수행할까? -> 없다.

심지어 오류도 존재한다. (마지막 코드의 주석)

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

위치를 표시하는 주석

// Action /////////////////////////////////////////
  • 때때로 프로그래머는 소스 파일에서 특정 위치를 표시하려 주석을 사용한다.
  • 극히 드물게 위와 같은 배너 아래 특정 기능을 모아놓으면 유용한 경우도 있다.
  • 하지만 일반적으로 위와 같은 주석은 가독성만 낮추므로 제거해야 마땅하다.

닫는 괄호에 다는 주석

  • 중첩이 심하고 장황한 함수라면 의미가 있을 수도 있다.
  • 하지만 (우리가 선호하는) 작고 캡슐화 된 함수에는 잡음일 뿐이다.
  • 닫는 괄호에 주석을 달아야겠다는 생각이 든다면 대신에 함수를 줄이려 시도하자.

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

/* 릭이 추가함 */
  • 소스 코드 관리 시스템은 누가 언제 무엇을 추가했는지 기억한다.
  • 저자 이름으로 코드를 오염시킬 필요가 없다.
  • 이런 주석이 오랫동안 코드에 방치되면 점차 부정확하고 쓸모없는 정보로 변하기 쉽다.
  • 이런 정보는 소스 코드 관리 시스템에 저장하자.

주석으로 처리한 코드

  • 주석으로 처리된 코드는 다른 사람들이 지우기를 주저한다.
  • 소스 코드 관리 시스템이 우리를 대신해 코드를 기억해준다.
  • 코드를 삭제하라. 잃어버릴 염려는 없다.

HTML 주석

HTML 주석 예제

소스 코드에서 HTML 주석은 혐오 그 자체다.

전역 정보

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

너무 많은 정보

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

다음은 base64를 인코딩/디코딩 하는 함수를 테스트하는 모듈에서 가져온 주석이다.

너무 많은 정보 예제

모호한 관계

  • 주석과 주석이 설명하는 코드는 둘 사이 관계가 명백해야 한다.
  • 독자가 주석과 코드를 읽어보고 무슨 소린지 알아야 한다.
  • 주석 자체가 다시 설명을 요구하지 말아야 한다.

함수 헤더

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

비공개 코드에서 Javadocs

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

오늘 읽은 소감은? 떠오르는 생각을 가볍게 적어보세요

고든램지

저자가 주석에 대해 엄청난 악담을 퍼붓는 것을 보고 위의 짤이 떠올랐다.

저자의 말대로 Git같은 소스 관리 프로그램이 코딩을 하는데 너무나 큰 도움을 주고 있기 때문에 나는 현재 TODO 주석만 유용하고 사용하고, 일반적인 주석은 최소한으로만 사용하고 있다.

책에서도 나와있듯이 주석으로 로그를 남기거나 작성자를 남기는 등의 관습은 이전에는 필요했으나 현재는 불필요한 관습이 되었다.

지금 내가 공부하고 사용하고 있는 관습이나 내용들은 미래에는 필요 없는 내용이 될 수 있으니 꾸준히 공부해야겠다는 생각이 들었다.

궁금한 내용이 있거나, 잘 이해되지 않는 내용이 있다면 적어보세요.

나쁜 코드를 설명하는 부분에서 HTML 주석에 대해 언급했는데 HTML 주석이 어떤 과정에서 생겨나고, 어디에 필요한지 궁금하다.

검색을 해보았지만 HTML 에서 사용하는 주석 처리 방법에 대해서만 결과가 나와서 원하는 결과를 찾기 어려웠다.

그 외 내용은 어렵지 않은 내용이었다.