[배운 점 & 회고] 5월 13일 실무를 마치고 느낀 점

작업한 내용

오늘은 기존 코드에 작성된 주석들을 점검하고, 보다 명확하고 일관성 있는 형태로 수정하는 작업을 진행했습니다. 기능 구현은 없었지만, 주석을 통해 코드의 의도를 더 잘 전달할 수 있도록 하는 것이 목표였습니다

기존 주석은 너무 포괄적이거나, 당연한 내용을 반복하고 있는 경우가 많아 오히려 가독성을 해치는 경우도 있었습니다. 반면 어떤 부분은 주석이 전혀 없어, 처음 코드를 읽는 사람이 이해하기 어려웠습니다. "어떤 부분에 어떤 깊이로 주석을 달아야 할까?"라는 기준을 스스로 세우는 데 고민이 있었습니다.

주석은 단순히 코드에 글자를 덧붙이는 것이 아니라, 협업과 유지보수를 위한 소통의 도구라는 점을 다시금 느꼈습니다. 특히 팀원이 없거나, 미래의 '나'에게 설명한다는 생각으로 주석을 작성해야 한다는 인식을 갖게 되었습니다. 앞으로는 기능 구현 시 주석을 함께 관리하며, 지나치게 상세하거나 추상적이지 않도록 기준을 세워나가고자 합니다.