Meaningful Code Comments

많은 사람들은 코드 주석이 해롭다고 말한다. 코드 주석 없이도 코드가 설명되게끔 짜야한다는 것이다.

의도(가독성 좋은 코드를 짜기 위한 노력) 자체는 좋다고 생각한다. 하지만 현업을 하다보면 코드 주석 없이는 코드를 이해하기 어려운 경우가 많다.

빠르게 제품을 출시하고, Agile 하게 돌아가는 팀에서는 제품에 대한 기획, 정책이 수시로 바뀌게 된다. 또한 제품의 성공을 위해서 기술 부채(technical debt, design debt, code debt) 를 남겨두기도 한다.

이러한 업무 환경에서 일할 때에는 코드 주석이 필수라고 생각한다.

Code Readability by Ishikawa Munetoshi