4장 : 주석

주석은 프로그램에 영향을 주지 않는다. 하지만 개발자는 코드와 주석을 둘다 읽어야 한다. 만약 주석이 많아지면 읽는 시간이 늘어나고 잘못된 주석으로 인해 프로그램을 잘못 고쳐 오류를 야기할수도 있다. 최선의 방법은 주석을 쓰지 않고 클래스나 함수의 이름들을 한눈에 알아볼수 있도록 하는 것이다. 하지만 주석 없이 코드를 쓰기란 많은 연습과 시간이 필요하다. 그렇다면 주석을 쓸때 그나마 좋은 방향으로 주석을 써나가면 많은 도움이 될 것이다. 주석은 1960년대에 많은 도움이 되었지만, 현재 IDE의 발달로 주석이 필요 없어지는 경우도 많다. 그나마 좋은 주석들을 사용하는 것 외의 추가적인 주석들은 그저 개발자들을 피곤하게만 할 뿐이다.

그나마 좋은 주석들

• 법적인 주석 : 저작권 정보나 소유권 정보같은 법적인 이유로 넣어야 하는 주석
• 정보를 제공하는 주석 : 해당 함수가 무엇을 반환 하는지 혹은 무엇을 뜻하는지 설명하는 주석
• 의도를 설명하는 주석
• TODO주석
• 의미를 명료하게 밝히는 주석 : 표준 라이브러리나 변경하지 못하는 코드 때문에 인수 값이나 반환값이 모호할때 의미를 알려주는 주석

개인적인 소감

깔끔해 보여서 혹은 상대방에게 설명하기 위해 주석을 많이 썼었다. 별 생각 없이 썼었던 주석인데, 주석을 쓰는 것 자체에도 이러한 방법들이나 불문율들이 있다는 것에 놀랐다. 지금은 실력이 부족해서 책에서 의도하는 바를 100 퍼센트 이해하지 못하지만, 나중에 회독수를 늘려가며 다시 한 번 정리해보면 조금 더 와 닿을 것 같다.

기억에 남았던 구절들

우리는 코드로 의도를 표현하지 못해, 그러니까 실패를 만회하기 위해 주석을 사용한다.(p.68)

주석은 오래될수록 코드에서 멀어진다.(p.68)

부정확한 주석은 아예 없는 주석보다 훨씬 더 나쁘다(p.69)

자신이 저지른 난장판을 주석으로 설명하려 애쓰는 대신에 그 난장판을 깨끗이 치우는 데 시간을 보내라!(p.69)