주석을 쓰는 것이 좋은가?

코드를 작성할때 다른사람이 알 수 있도록 주석을 다는 것은 당연하다라고 생각해왔다.

하지만, 과연 프로그램을 작성할 때 주석을 사용하는 것이 좋은가?

주석은 필요할 경우에만 작성하되, 그렇지 않은 경우에는 사용하지 말자.

주석은 자신이 작성한 코드를 자신 또는 다른 프로그래머가 해당 클래스 또는 함수를 해석할 수 있도록 돕는 키워드이다.

코드를 설명하기 위한 주석은 당연히 필요하다. 하지만 어떤 코드를 작성할 때마다, 어떤 함수는 무슨 기능이고, 어떤 부분은 어떤 기능을 하는지에 대한 기술하는 것은 코드가 지저분해 보이고, 가독성을 떨어뜨린다. 

그럼 어떻게 해야할까? 충분히 주석이 필요없는 함수나 클래스는 네이밍으로 충분히 커버된다. 

예를 들어 sum이라는 함수가 무엇일까? 정확히는 알 수 없어도 무엇인가를 더하는 함수라고 생각 되지않는가?  

 sum(int a, int b){...} // 합을 구하는 함수

이렇게 주석을 달게 되면 오히려 지저분해보이기 때문에, 네이밍으로 커버가 가능하다면, 주석을 달지 말자.

코드가 설명이 아니고, 코드자체를 위한 주석이라면??

코드자체를 위한 주석을 사용하지 말자. 프로그래머A가 작성을 하고 난 뒤, 프로그래머B가 프로그래머A가 작성한 코드를 수정한다고 생각하자. 프로그래머A가 코드에 주석을 달아 놓았다면, 프로그래머B는 그 주석처리된 코드를 지울까? 절대 지우지 않을 것이다. 주석된 코드의 사용여부를 알 수 없기때문이다. 결국, 주석된 코드는 프로젝트의 쓰레기코드로 영원히 남게 될 것이다. 이런 이유로 필요없는 코드주석은 사용하지 않도록 주의하자.

Clean Code: A Handbook of Agile Software Craftsmanship를 읽고...