내가 작성한 코드
늦은 시간 지인과 채팅을 하다가 지인께서 주석을 달지 않는다는 말에 솔깃하여 좋은 코드와 주석에 대해서 많은 이야기를 나누었습니다. 물론 코드와 주석의 관계는 예전부터 말이 많았었고, 오죽하면 MS에서 낸 Code Complete(책)에서도 코드와 주석에 대해서 한 챕터(Chapter)를 할애해서 설명했겠습니까? ^^;;;
지인께서는 주석이 사실 거의 필요 없고 코드를 간결하게 짜면 코드가 모든걸 설명해 줄꺼라 말씀하셨지만....
저는 주석이 아예 필요없다고 생각하시는 것은 아닌지... 혹시나 하는 마음에 여러 이야기를 나누어봤는데, 리눅스 커널 프로젝트를 예로 들면서 주석이 별로 없어도 코드를 간결하게 작성하면 된다고 하셨습니다. 제가 리눅스 커널을 깊게 보지는 않았지만 주석이 거의 없었던 듯....(아닐수도 있습니다. ^^;;;)
물론 주석이 가지는 문제가 많습니다만은, 저는 코드에 주석을 풍부하게 달아야 한다고 생각하기에 여러 딴지를 걸었는데요, 글쎄요... 아무리 프로그램을 간단하게 짜고 코드가 모든 것을 설명해 줄 수 있게 의미있는 함수명을 짓고 변수명을 붙인다 하더라도...
이것은 어디까지나 지극히 "개인적인" 기준이라고 생각합니다. 만약 후임이나 혹은 팀으로 작업을 한다고 했을 때 소스코드 분석을 먼저하게 될텐데... 주석하나 없는 코드를 볼때의 임펙트(??)는 둘째치고 주석 한줄(~~해서 ~~하여 ~~한다)이면 "알수있는" 부분을 코드 전체를 뒤져서 "알아내야" 하는 시간적인 낭비는 무시 못한다고 생각합니다. ^^;;;;
특히나 생각이 꼬여(??)있으신 분이라면 아무리 쉽게 모듈을 나누고 정리하더라도 다른 사람이 쉽게 이해하긴 힘들겠지요.
저는 코딩할때 주석을 꽤나 많이 다는 편인데, 다른 분들은 어떻게 생각하실지 궁금하군요. (갑자기 그동안 릴리즈 해놓은 많은 소스코드가 마음에 걸려서 뜨끔하다는... ^^;;;;)
코드에 주석 많이 다세요?
'잡담' 카테고리의 다른 글
내일이 ACM 대회인데... 이글루스에서 티스토리로 이사를 하고 있습니다... ㅜ_ㅜ (2) | 2007.11.15 |
---|---|
불기를 이용한 유저 인터페이스 개발~ 신선한 발상의 전환~!! (0) | 2007.11.15 |
소스 코드를 겨우 다 서브버전으로 옮겼습니다. ^^;;; (0) | 2007.11.14 |
티스토리 블로그 개설~!! @0@)/~ (0) | 2007.11.13 |
[잡담] 이틀에 걸쳐 기신대전 기간틱 포뮬러를 다 봤다.... (0) | 2007.10.26 |