주석..주석에 대한 개인적인 고찰

항상, 주석을 달면 다음에 읽을 사람을 위해 자세히 달아 주면, ( 아! 다음 사람이 이 주석을 보면서 코드를 더 잘 이해하실 수 있겠지?)라고 생각하며 기분 좋은 마음으로 달아주었다..

 

하지만 직접 실무를 다루게 되고, 다른 사람이 만들어 놓은 코드를 읽을 때면 주석이 무조건 좋은 것이 아니라는 것을 깨달을 수 있었다...

 

클린코드에서는 아래와 같이 좋은 주석과 나쁜 주석을 분류해놓았다.

 

😆  좋은 주석

법적인 주석

의도를 설명하는 주석

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

결과를 경고하는 주석

TODO 주석

중요성을 강조하는 주석

 

😱  나쁜 주석

주절거리는 주석

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

오해할 여지가 있는 주석

의무적으로 다는 주석

있으나 마나 한 주석

무서운 잡음

함수나 변수로 표현할 수 있다면 주석 X

닫는 괄호에 다는 주석

등..

 

이렇게 분류를 해놓았고, 읽으면서 어느 정도 이해를 했다.

그리고 깨달은 것은 코드로 작성자의 의도를 파악할 수 있도록 '이야기를 하는 것과 같은 코드'를 최대한 짜는 것이 중요하다는 것이다...

그리고.. 코드로 절대 모든 이야기의 내용을 표현할 수 없다면 주석을 사용하는 것이 가장 베스트라는 것을.. (개인적인 의견입니당..)