택배 상자와 주석

[al-bur]

운동을 마치고 엘리베이터를 타고 집으로 향하던 길, 문 앞에 놓인 택배 상자가 눈에 들어왔다. 당연히 집 안으로 가져가려던 순간, 상자에 적힌 "반품"이라는 메모를 발견했다.

부모님이 반품 처리를 위해 밖에 내놓으신 택배였던 것이다. 만약 그 한 줄의 메모가 없었다면? 나는 아무 생각 없이 택배를 집 안으로 들고 들어갔을 것이고, 마침 부재중이셨던 부모님은 당일 반품 기한을 놓치는 최악의 상황을 맞이했을지도 모른다.

문득 머릿속에 한 가지 생각이 스쳤다.

"이거... 코드의 주석과 똑같은 상황 아닌가?"

필요한 곳에 주석이 없으면 불필요한 작업이 반복되고, 팀원 간 불필요한 커뮤니케이션이 발생한다. 최악의 경우 버그가 프로덕션까지 배포되어 고객에게 직접적인 불편을 줄 수도 있다.

택배 상자 위의 작은 메모 한 장처럼, 코드 속 주석 한 줄이 얼마나 중요한지 새삼 깨닫는 순간이었다.
...사실 억지로 끼워맞춰본 건 안 비밀이다.

[raymondanythings]

하지만 메모를 보고 개봉했더니 벽돌이 들어있다면.....?

[al-bur]

ㅋㅋㅋㅋㅋㅋㅋㅋㅋㅋㅋㅋㅋㅋㅋㅋㅋㅋ그런경우도 있죠... 그러면 이제 다 엎는 상황이 발생...

[airman5573]

복잡한 로직에 주석 몇줄 적혀져 있으면 '아~ 이말이구나' 하고 고맙더라구요.

[al-bur]

맞아요 근데 애초에 주석이 필요없이 잘 읽히는 코드가 이상적이긴한데, 실상은 바쁘거나 조급하거나 그런 상황에서 반창고들을 붙이면서 생긴 코드와 실수를 방지하기위한 주석들의 향연이 많은 것 같아용

[yoonminsang]

최근에 이직을 하면서 주석에 대한 중요성을 크게 느껴서 블로그 글도 작성했는데 여기서 또 보니 반갑네요ㅎㅎ
택배상자 예시 진짜 적절하네요 👍

[al-bur]

바로 생각나더라고요ㅎㅎ감사합니다

[al-bur]

최근에 이직을 하면서 주석에 대한 중요성

오 궁금합니다! 블로그 글 주소라도 공유해주실 수 있나용/

[yoonminsang]

네! 뭔가 이렇게 여쭤보니 부끄럽네요ㅎㅎ

https://ms3864.tistory.com/480