[Programming] - CleanCode 04. 주석


결론부터 말하자면 주석은 결국 나쁘다.

가장 큰 이유는 주석은 코드의 개선사항을 잘 따라가지 못해 거짓말을 하게되는 경우가 많다.

3장과 4장을 이어서 보면서 느낀점은

주석과 같이 설명을 잘하는 이름을 지어서

주석과 이름이 합쳐지게 만들어라 라고 스스로 결론을 내렸다.

코드의 의도를 주석이 아니라 추상화를 통해 함수 이름이나 변수로 나타내라

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

경우에 따라 좋은 주석은 다음과 같다.

하지만 그래도 주석을 최대한 없애는게 좋다. 그렇다고 주석을 아예 쓰지 말라는게 아니라 상황에 맞춰서 사용하라는 의미이다.

  1. 법적인 주석
  2. 정보를 제공하는 주석
가능하다면 함수 이름에 정보를 담는 편이 좋다.
  1. 의도를 설명하는 주석

    구현의 이해를 넘어 해당 의사 결정의 배경까지 설명이 가능하다.

  2. 의미를 명료하게 밝히는 주석
  3. 결과를 경고하는 주석
  4. TODO 주석
  5. 중요성을 강조하는 주석