clean code를 위해서 주석을 안 쓰는 것이 언제나 좋은가?

이번 프로젝트에서 clean code를 지향하면서 주석을 안 적으면서 진행을 하였다.

다만, 주석이 없다 보니 코드 리뷰를 하는데 시간이 더 걸리고 pr을 하기가 힘들어지는 결과를 낳았다.

 

클린코드에서는 주석을 필요악이라고 하지만 좋은 주석의 경우도 동시에 설명을 해주고 있다.

1. 정보를 제공하는 주석

2. 의도를 설명하는 주석

3. 의미를 명료하게 밝히는 주석

4. 결과를 경고하는 주석

5. TODO 주석

6. 중요성을 강조하는 주석

등은 좋은 주석이라고 한다.

 

주석을 없애는 것을 목표로 해야 한다고 하지만 프로젝트의 초반에 주석을 써주는 것이 오히려 프로그래머들간의 의사소통에 더 효율적인 경우도 있다고 생각한다.

이번 프로젝트에서 서버에서 이미지를 받아오는 부분을 다른 사람이 쓰는 것을 쓰다보니 제대로 이해하지 못하는 부분들이 생겼고 결과적으로 중복적으로 서버에서 계속 이미지를 받아오면서 문제가 발생하였다.

적절한 주석을 활용해 프로그래머간의 의사소통을 활성화 시키자.

 

출처 : Clean Code

저자 : 로버트 C. 마틴