[스터디] 클린코드 4장 (2022년 6월 14일)

4장. 주석

 

4장의 포인트

주석이 과연 좋을까?

 

솔직히 소제목만 읽어도 4장을 다 읽은 거나 다름이 없다.

 

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

주석 대신 코드를 사용해서 의도를 충분히 전달 가능하다.

주석을 달아야겠다는 것은 코드를 정리하라는 신호이다.

 

코드로 의도를 표현하라!

주석을 사용할 것이면 주석 대신 함수로 표현해라

예를 들어 긴 계산식을 적어놓고 주석을 달지 말고 함수로 만들어서 함수명으로 알아보기 쉽게 해라

 

좋은 주석

• 법적인 주석
• 정보를 제공하는 주석
• 의도를 설명하는 주석
• 의미를 명료하게 밝히는 주석
• 결과를 경고하는 주석
• TODO 주석
• 중요성을 강조하는 주석

가장 와닿는 주석은 TODO 주석이다.

TODO 주석을 위한 extenstion도 설치했었다.

하지만 TODO주석도 주석이므로 주기적으로 삭제를 해주어야 한다.

 

나쁜 주석

대부분 나쁜 주석에 포함된다.

엉성한 코드를 변명하기 위한 도구이며 코드를 오해할 여지를 준다.

• 주절거리는 주석
• 같은 이야기를 중복하는 주석
• 오해할 여지가 있는 주석
• 의무적으로 다는 주석
• 이력을 기록하는 주석
• 있으나 마나 한 주석
• 위치를 표시하는 주석
• 닫는 괄호에 다는 주석
• 공로를 돌리거나 저자를 표시하는 주석
• 주석으로 처리한 코드
• HTML 주석

이렇게 나열해도 엄청 많다..

 

여기서 가장 와닿는 주석은 주석으로 처리한 코드이다.

 

리팩터링을 진행하다 보면 이전 코드들을 주석 처리해놓고 삭제하지 않는 경우가 많았는데

나중에 코드를 돌아보게 되면 뭔가 이유가 있어서 주석처리해놓은 건가 싶어서 건들지 못하는 코드들이 존재한다.

많이들 깃허브로 코드를 관리하니 과감히 코드를 삭제하도록 하자.

 

결론

주석은 없는 게 좋다.

하지만 필요하다면 최대한 신경 쓰고 관리하자.

그냥 최대한 사용하지 않도록 노력하는 게 최고인 듯...