해당 포스트는 Clean Code의 내용을 참고하여 작성되었습니다.

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

코드에 주석을 추가하는 일반적인 이유는 코드 품질이 나쁘기 때문이다. 모듈을 짜고 보니 짜임새가 엉망이고 알아먹기 어렵다. 지저분한 모듈이라는 사실을 자각한다. 그래서 자신에게 이렇게 말한다. 주석을 달아야겠다고. 아니다. 코드를 정리해야 한다.

자신이 저지른 난장판을 주석으로 설명하려 애쓰는 대신에 그 난장판을 깨끗이 치우는데 시간을 보내라

위치를 표시하는 주석

// Actions /////////////////////
극히 드물지만 위와 같은 배너 아래 특정기능을 모아놓으면 유용한 경우도 있긴 있다. 하지만 일반적으로 위와 같은 주석은 가독성만 낮추므로 제거해야 마땅하다. 너무 자주 사용하지 않는다면 배너는 눈에 띄며 주의를 환기한다.

그러므로 반드시 필요할 때만, 아주 드물게 사용하는 편이 좋다.