나/생각 주머니

주석은 중요하다

Lou Park 2023. 10. 15. 01:15

지난 2주는 아주 고통스러웠다.


긴 연휴가 끝나고 마법처럼 이슈들이 빵빵 터졌다. 마치 잘 쉬었냐고 인사하는 것처럼...
긴 이슈의 터널을 통과하면서 "주석은 중요하다"라는 것이 뼈저리게 느껴졌다. (모든 것이 주석때문은 아니었지만)

물론, 주석은 해가 되기도 한다.

- 별다른 주석 없이 주석처리된 코드
- 코드와 맞지 않는 Outdated된 주석
- 쓸모없는(redundant) 주석


Clean Code 열풍과 함께 주석 없는 코드가 완전히 대세가 되었다.
"주석 없이도 읽힐 수 있는 코드가 잘 짜여진 코드다"라는 말 한번쯤 들어보셨으리라 생각한다.
나도 그에 동의했고, 되도록이면 주석을 적지 않으려고 했다.

마틴 파울러 선생님이 틀렸다고는 생각하지 않지만, 내가 틀렸다고는 생각한다.
내가 쓴 코드가 정말 주석없이 잘 읽힐 수 있는 코드가 맞냐? 
그에 대한 대답에서 자유로워야 할 것이다.

중요한 비즈니스 로직을 담당하는 함수 하나에 수십줄 박아두고 주석하나 없었다.

그 당시에는 그 로직에 대한 이해가 빵빵해서 그렇게 적었을 지 모르지만, 몇 개월 후 이슈가 빵 터져서 다시 보게 되었을때 다시 코드를 이해는데 걸리는 시간은 치명적이다. 협업중이라면 상황은 더 나빠진다.

GTA5 마이클의 유명한 대사가있다.
"넌 하루에도 수천가지를 잊어버려"

기억력에 대한 패배를 인정하고 주석을 잘 적어봐야겠다.