더북(TheBook)

 

2.5

주석

중학생일 때 학교를 마치고 집에 왔는데 식탁에 쪽지와 함께 3천 원이 놓여 있었습니다.

배고프지? 짜장면 사 먹으렴.

- 엄마가

당시 짜장면 가격은 딱 3천 원이었고, 배가 무척 고팠기에 바로 짜장면을 시켜서 아주 맛있게 먹었습니다. 그런데 쪽지가 없었다면 어땠을까요? 왜 3천 원이 식탁에 놓여 있는지, 누가 올려 둔 것인지, 무슨 용도인지, 왜 3천 원인지 등 의문이 생겼을 것입니다.

코딩하다 보면 분명 과거의 내가 만든 코드인데 왜 이렇게 작성했는지 이해할 수 없는 경우가 있습니다. 때로는 추가 설명이 필요한, 복잡한 코드를 작성해야 할 때도 있고, 특별한 의미가 있는 어떤 값을 사용해야 할 때도 있습니다. 특히 다른 누군가와 함께 코드를 작성한다면 서로 이해할 수 있게 부연 설명이 필요할 때도 있지요. 이런 경우에 주석(comment)을 사용하면 좋습니다.

신간 소식 구독하기
뉴스레터에 가입하시고 이메일로 신간 소식을 받아 보세요.