[소고] 주석 달아 봅시다

@codemaru · October 11, 2001 · 3 min read

어제 책을 두권 샀었는데...

C++책 한권에 좋은 내용이 들어있어서... 전해 드리려고 이렇게 글을 씁니다...

우선 책은... Practical C++인가로... 오렐리사의 책을 한빛미디어에서 번역해서...

출판한 것입니다... 책의 3장에 보면 코딩 스타일에 대해서 쭈욱 나와있는데...^^;;

저자는 주석의 강조를 아주 많이 하고 있더군요... 사실 프로그래밍을 할때...

제일 하기 싫은것이 도큐먼트작성이 아닌가 합니다... 하지만 책에서는...

변수하나하나 마다의 주석을 달기를 권유하고 있습니다... 그런데 생각을 해보면..

저자의 말이 맞는것 같습니다... 전 예전부터... 남이 짠 소스나... 남의 컴포넌트를

이용하는것을 기피하는 아주 우스운 습관이 있었습니다... 그러나 저자는 강력하게..

말하고 있습니다... 프로그래밍의 80%는 코드의 유지보수이다... 완전히 새로운 ..

프로그램을 짜는 일은 그렇게 많지 않다. 따라서 주석을 많이 달아라~~~^^;;

최대한 남을 배려한 코딩을 하라~~~^^;; 입니다... 꽤... 마음에 와닿는 내용같네염...

남을 배려하는 코딩이라~~~^^;;

*str++ = *ptr++;

늘 저렇게 쓰던 제가 새삼 민망해지는 순간이었습니다...

*str = *ptr;
++str;
++ptr;

위의 코드가 더 좋은 코드라는 군요... 실제로 컴파일러가 원시코드를 생성할때도...

++str이 str++보다 더 간편하고... 효율적인 코드라고 합니다~~~^^;;

코드가 짧아야 최적화가 되어있다는 저의 생각이 완전히 뭉게지는 순간이었습니당...

다들 남을 배려하는 코딩을 합니다... 누군가 언제, 어떻게 제 소스를 수정해야할지..

모르니까염...^^;;

💡 2023-11-23

변수마다 주석은 미친 짓이다.
주석은 최소화 하는 게 좋다는 생각이다.
변수마다 주석을 달게 아니라 주석을 안 달아도 될 정도로 변수명을 짓는 게 좋다.
주석과 코드 사이에는 불일치가 발생할 수 있고, 그것 또한 비용이다.

*str++ = *ptr++; 이런건 취향껏 써라.
저런 거에 성능이 어쩌고 따지는 소리는 그냥 무시해도 된다.

새로운 코드를 쓰는 것보다 유지보수가 80%라는 말은 팩트다.

@codemaru
돌아보니 좋은 날도 있었고, 나쁜 날도 있었다. 그런 나의 모든 소소한 일상과 배움을 기록한다. 여기에 기록된 모든 내용은 한 개인의 관점이고 의견이다. 내가 속한 조직과는 1도 상관이 없다.
(C) 2001 YoungJin Shin, 0일째 운영 중