4장. 주석

코드는 언제든 변한다. 아무리 좋은 코드라도 변할 수 밖에 없다.

코드가 변하면 주석도 변해야 한다. 가장 좋은 방법은 주석을 사용할 일이 없게 코드를 짜는 것이다.

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

주석을 다는 이유가 무엇일까?

코드만으로는 전달하고자 하는 의도를 전달하지 못할 때 사용할 것이다.

하지만 주석 대신 추상화하여 함수로 표현해도 될 것이다.

좋은 주석

법적인 주석

저작권, 소유권 같은 파일 첫머리에 들어가는 정보들은 주석이 들어갈만한 이유로 충분하다.

의도를 설명하는 주석

로직 자체를 설명하는 것은 좋지 않다. 로직을 왜 그렇게 짰는지에 대한 의도를 설명하는 주석은 괜찮다.

TODO 주석

때로는 '앞으로 할 일'을 주석으로 남겨두면 편하다.

// TODO: descreiption~~~~~
function func1() {
    // ...
}

나쁜 주석

대다수의 주석이 여기에 속한다.

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

코드의 로직을 주석으로 표현하는 경우를 말한다. 주석이 없더라도 코드만으로도 로직이 충분히 해석이 되는데도, 주석으로 한번 더 설명하는 경우다.

주석으로 처리한 코드

이건.. 더 말해봤자 입 아플것이다.

우리에겐 git과 같은 버전관리 시스템이 있다.

안쓰는 코드를 굳이 주석으로 남겨두지 말자.