[Clean Code] 4장 주석

주석은 항상 거짓말을 한다.

  : 코드는 살아 있는 생물체라 항상 변화하고 진화하지만, 주석은 계속 퇴화한다.

 

- 주석은 나쁜 코드를 보완해서 안된다. 코드로 의도를 표현하라

 

좋은 주석

- 법적인 주석

- 정보 제공 주석

- 중요성 강조 주석

- 경고 주석

- TODO 주석

 

나쁜 주석

- 주절거리는 주석

- 코드와 중복된 내용 적는 주석

- 오해할 여지가 있는 주석

- 이력을 기록하는 주석 (버전 관리 시스템이 있어서 요즘은 안 하죠)

- 주석으로 처리한 코드 (버전 관리 시스템이 있으니 그냥 지웁시다)

- 너무 많은 정보

- 함수 헤더