언제 코드에 주석을 달아야 할까?

코드에 주석을 어떻게 달아야 하는지 질문이 있어서 나만의 원칙을 정리해 보았다.

fantazic 코드 주석 원칙

1. 주석보다는 테스트 케이스를 작성하자.
2. 주석보다는 의미있는 이름을 사용하자.
3. 필요하다면, 클래스와 메소드의 역할에 대한 주석을 남기자.
4. API를 작성하는 경우, 주석을 충분히 자세하게 남기자.

최근에는 코드를 작성하는 시간이 줄어들었다. 실질적인 개발을 하고 싶지만, 기술 지원, 코칭, 설계 등 코드와는 동떨어진 업무에 더 많은 시간을 사용하고 있다.

그래서 배우고 생각한 것이 있어도 바로 실천으로 옮기지 못하는 경우가 많다. ‘주석을 다는 원칙’도 프로젝트에 직접 적용해 보면서 개선해 나가야 하는데 원칙만 있을 뿐 경험이 따라주지 못하고 있다.

최근 작성한 코드를 돌이켜 보니, 주석을 너무 무시했던 것 같다. 공통 모듈을 개발하면서 주석이 부족했으니 사용하는 개발자가 쉽게 가져다 쓰기 힘들었을 것이다. 무엇이든지 한번에 잘 되는 것은 없기 때문에 빠르게 자주 개선시켜 나가야겠다.