주석

[클린코드] 4. 주석

내가 주석을 추가할 때 코드로 설명하기 어려움이 있어서 추가하는 경우가 대부분이었다. 그러나 프로그래밍 언어를 통해 의도를 표현할 능력이 있다면, 주석은 전혀 필요하지 않다고 저자는 말한다. 하지만 아주 특별한 경우 좋은 주석도 존재한다고 설명한다. Q. 주석이 있으면 왜 안좋은가? A. 코드는 변화하고 진화한다. 이러한 과정에서 주석은 코드를 정확히 따라가기(업데이트되기) 힘들다. 따라서 부정확한 정보를 제공하는 주석으로 남을 가능성이 있다. 주석은 나쁜 코드를 보완하지 못한다 코드에 주석을 추가하는 일번적인 이유는 코드 품질이 나쁘기 때문이다. 위에서도 말했듯이 코드 작성자가 코드로 설명하기 힘든경우 코드외에 주석을 추가하여 의도를 설명한다. 즉, 클린코드 관점에서 서술적인 코드가 되지 못한것이다. ..