코드 주석을 최소화 해야하는 이유

불필요한 주석은 코드를 이해하기 어렵게 만든다. 

단순히 copy&paste로 주석을 붙이다가 기능에 맞는 내용으로 변경한다는걸 깜박했다거나

시간이 흘러 주석 내용과는 다른 흐름으로 로직이 변했지만 업데이트가 제때 이루어지지 않은 주석 덕분에

레거시 코드를 이해하는데 한참씩 걸리곤 할 때가 있다.

 

주석은 꼭 필요할 때만 달아야 한다고 생각하는데,

꼭 필요할 때라는 시점은 코드만으로 로직을 이해할 수 없을 때를 말한다.

 

주석 없이도 변수명이나 메소드명만으로도 충분히 이해할 수 있는 내용의 코드라면 굳이 왜 주석을 달아야 하는가?

나는 컨트롤러나 서비스 메소드위에 다는 주석을 지양하는 편인데 param, return Type이 바로 밑에서 확인할 수 있는데 

기본 4-5줄씩 차지하는 주석을 굳이 써야하는가?? 싶기 때문이다.

 

바꿔말해보자면 주석을 달기 전에

이 주석이 없이 동료가 코드만 보고 비즈니스를 충분히 이해할 수 있도록 리팩토링 해볼수 있을까?

부터 고민해보는게 맞는 것 같다. (대게 메소드명을 바꾼다거나 메소드 추출을 통해 해결될 때가 많다고 생각한다.)

 

오늘도 잘못씌여진 주석으로 한참을 헤매일 뻔(?)해 적어본다.