클린 코드 : 주석

 

주석

 

부정확한 주석은 아예 없는 주석보다 훨씬 나쁘다 

 

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

- 일반적으로 주석을 사용한다는 것은 코드 품질이 나빠서 별도의 설명이 필요하다는 뜻이다 

- 주석을 달 시간에 코드를 정리해라 - 그러고보니 js는 주석 없이 작성하던데 이걸 의도한 건가? 

 

코드로 의도를 표현하라 

- 그냥 주석 달 생각하지 말고 영단어로 메서드 만들어서 보기 좋게 하자 

if (employee.isEligibleForFullBenefits())

 

좋은 주석

- 법적인 주석 

// Copyright (C) 2003, 2004, 2005 by Object Montor, Inc. All right reserved.
// GNU General Public License

- 정보 제공하는 주석

- 의도를 설명하는 주석 

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

- 결과를 경고하는 주석

- todo 주석

- 중요성 강조하는 주석 

 

나쁜 주석 

- 주절거리는 주석 

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

- 오해할 여지가 있는 주석

- 의무적으로 다는 주석 : 이거 우리 팀에서 하고 있는 건데..;; 나름 도움 되는데...;

- 이력을 기록하는 주석

- 있으나 마나한 당연한 이야기를 적은 주석

- 함수나 변수로 표현 가능하면 주석 달지마라

- 닫는 괄호에 다는 주석

- 주석으로 처리한 코드 

 

참고

https://product.kyobobook.co.kr/detail/S000001032980

Clean Code(클린 코드) | 로버트 C. 마틴 - 교보문고