[클린 코드] 주석

오늘 TIL 요약

• 가급적 주석을 달지 말아라

4장. 주석

책에서 기억하고 싶은 내용

• 주석은 나쁜 코드를 보완하지 못한다.(p.69)
  주석을 추가하는 일반적인 이유는 코드 품질이 나쁘기 때문이다.
  지저분한 모듈이라는 것을 알아차리는 순간 "주석을 달아야겠다!"가 아닌 "코드를 정리해야겠다!"가 되야한다.

• 좋은 주석

  • 법적인 주석
  • 정보를 제공하는 주석
    (가능하다면 함수이름을 정보 담는 편이 더 좋긴하다.)
  • 의도를 설명하는 주석
  • 결과를 경고하는 주석
    ex) 특정 테스트 케이스를 꺼야하는 경우..
  • TODO 주석

소감

프로그래머의 뇌가 아직 성장하고있어서 그런가보다.
난 아직 코드를 읽는 것보다 줄 글로 써진 주석을 읽는 것이 더 편하게 느껴져서 애매모호한것이 있으면 주석으로 보충을 해왔다.
책에서 주절거리지 말라고 당부한 대목을 보자마자 수없이 적었던 주석이 떠올랐다.
그리고 깃이라는 아주 좋은 형상관리를 하고있으면서도 수정한 코드를 지우기보다 주석처리하고 수정을 했었다.(지금 생각하니까 왜 그렇게 했는지 나조차도 이해가 안간다 🥲)

주석은 필요악이다.
주석을 마치 치트키 처럼 생각해왔던 과거를 반성하게 되었다.
결국은 함수 파트때와 마찬가지로 모호하게 하지 말자!
모호하지 않으면 주석은 달 필요가 없다!