[클린코드 요약] 4. 주석

 나는 평소에 협업을 하기 위해서는 내 코드를 보기 편하게 만들 필요가 있다고 생각했고, 그래서 주석을 자주 활용하곤 했는데 이 부분을 읽으면서 그게 과연 맞는 것일까 하는 생각이 들었다.

---

 저자는 주석을 다는 것을 지양해야 한다고 말하고 있다. 주석을 다는 것보다 코드로 충분히 표현할 수 있는 방법을 찾아야 한다고. 우리의 일은 코드를 짜는 것이지, 주석을 짜는 것이 아니기 때문에 코드를 작성하고 수정하다보면 주석이 그 자체의 의미를 잃어버릴 수 있기 때문이다. 예전의 코드는 수정됐지만, 주석은 업데이트되지 못하고 예전의 상태를 유지하는 걸 (짧은 경험이지만) 많이 봐왔고, 느꼈다. 결국 주석은 거짓이 되어버리고, 주석을 단 의미가 사라진 것이다.

 그럼에도 저자가 좋은 주석이라고 생각하는 몇 가지가 있었다. 법적인 저작권이나 소유권 정보들을 나타내는 주석, 기본적인 정보를 제공하는 주석, 의도나 의미를 밝히는 주석, 다른 프로그래머에게 경고하는 주석, TODO 주석, 공개 API에서의 Javadocs 주석 등이 그렇다.

 반면 그외에 없애도 된다고 생각하는 나쁜 주석은 별 의미 없는 단, 있으나 마나한 주석, 코드로 충분히 표현할 수 있으나 단 주석, 위치를 표시하는 주석이나 닫는 괄호에 다는 주석, 저자를 표시하는 주석, 주석으로 처리한 코드 등이다.

 특히 요즘같은 경우 git 등의 버전관리도구가 잘 되어있기 때문에 저자를 표시하는 주석이나 주석으로 처리한 코드 등은 과감히 지워도 된다고 말하고 있다.