본문 바로가기
코딩 필독서/클린코드

클린코드5

by 티코딩 2022. 11. 30.

저자는 프로그래밍 언어를 잘 사용해 의도를 제대로 표현할줄 알면 주석은 굳이 필요없다고 한다. 주석은 언제나 실패를 의미한다고 한다. 이따금 주석 없이 자신을 표현할 방법을 찾지 못해 할 수 없이 주석을 사용한다고 한다. 나도 코플릿에서 알고리즘을 풀며 내가작성한 코드인데도 이해하기 힘들어 주석을 아주 떡칠했던 경험도 있다. 저자는 주석을 매우 싫어하는것같아 보인다. 주석은 항상 거짓말을 한다고 한다. 주석은 오래될 수록 코드에서 멀어진다고 한다. 주석을 유지보수하는 것은 매우 힘들다고 한다. 코드는 항상 유지보수되며 진화하지만 그에따라 주석을 유지보수하는것은 현실적으로 힘들다. 

저자는 주석이 나쁜 코드를 보완하지 못한다고 한다. 주석으로 설명을 덧붙히지 말고 코드의 품질을 높혀야겠다고 생각하라고 한다. 앞서 말했듯이 주석으로 표현하지말고 코드로 의도를 확실히 표현하라고 한다. 주석으로 할 설명대신 함수로 만들어 표현하는 쪽이 훨씬 낫다고 한다. 

그렇다고 모든 주석이 나쁘단것은 아니다. 법적인 주석 - 저작권정보, 소유권 정보 등 첫머리에 작성되는 주석, 정보를 제공하는 주석 - 기본적인 정보를 주석으로 제공하면 편하다. 의도를 설명하는 주석, 의미를 명료히 밝히는 주석, TODO주석 등이 있다. 

저자가 나쁜 주석으로 예를 들었던 것중에 주절거리는 주석이 있었다. 정말 내가 작성했던 주석과 정확해서 웃겼다. 다시는 그렇게 달지 말아야 겠다. 

 

'코딩 필독서 > 클린코드' 카테고리의 다른 글

클린코드8  (0) 2022.12.14
클린코드6  (0) 2022.12.05
클린코드4  (0) 2022.11.25
클린코드3  (0) 2022.11.21
클린코드2  (0) 2022.11.19