옛날의 나: 어디선가 ‘주석은 코드가 설명되지 않을 때 쓰는 것. 주석이 없어야 좋은 코드’라는 생각을 주입받음.
지금의 나: 주석을 구구절절 남김.
# NOTE (@han2): 이건 왜 이런지 모르겠어요ㅠㅠ 일단 놔둠.
...
# TODO (@han2): 안 쓰는 코드 같음. 확인 후 지우기.
...
# Case1: 최대 근로시간 예외처리가 된 경우
if ...:이제는 주석을 잘 쓰는 것이 코드 이해에 훨씬 도움이 된다는 걸 깨달음. 코드 조건을 그대로 반복하는 주석은 오해를 일으키기 쉽다는 것도 배움. 특히 로직이 변경되었는데 주석이 그대로라면 문제가 될 수 있음. 그래서 상황을 설명하고, 비개발자도 이해할 수 있을 정도로 명확하게 작성하려고 함.
• 요즘엔 레포에 주석을 하도 많이 남기다 보니 # 만 쳐도 코파일럿이 내 말투로 주석을 완성해줌. 코파일럿의 자동완성은 특히 테스트 코드 작성과 주석 작성에 아주 유용함.
TODO 역시 방향성이 구체적일수록 좋다는 것을 느낌. 하지만 모두가 같은 방향성을 보지 않을 수 있다는 점도 항상 염두에 둬야 함. 그래서 TODO를 주기적으로 정리하고, 필요 없는 것들은 과감히 제거하는 과정이 중요하다는 것도 깨닫게 됨.