주석은 필수?

Question

안녕하세요 직접적으로 DB와 관련있는 질문은 아니지만 내용을 복습하다 궁금한 점이 생겨 질문을 드립니다. 코드를 짤 때 다른 사람과의 협업이 기초이니 그것을 기반하여 만드는 것이 좋은 코드라고 알고 있는데, 그럼 주석은 거의 모든 메서드에 다는 것이 좋을까요? 아니면 메서드명을 명확히 한다면 그것만으로 충분한 것일까요? 물론 팀마다 프로젝트마다 다르겠지만 평균적으로 현업에서는 어느 정도로 주석이 달리는지 궁금합니다.

y2gcoder · Answer

안녕하세요. 자프링님, 공식 서포터즈 y2gcoder입니다. 메서드 이름이나 파라미터 이름, 그리고 테스트 코드를 잘 짜면 주석의 필요성이 줄어든다고 생각합니다. 그래도 다만 주석이 필요한 경우는 있다고 생각합니다. 적절한 주석은 좋다고 생각합니다. 다음 링크(클릭) 에서 클린코드에서 말하는 주석에 대해 예시와 함께 잘 정리해놓았다고 생각해서 공유하겠습니다 :) 감사합니다.