TIL (Today I Learned)

오늘 읽은 범위

4장. 주석 ~ 좋은 주석

책에서 기억하고 싶은 내용을 써보세요.

• 주석은 기껏해야 필요악이다. 주석은 오래될수록 코드에서 멀어진다. 오래될수록 완전히 그릇될 가능성도 커진다. 프로그래머들이 주석을 유지하고 보수하기란 현실적으로 불가능하니까. 프로그래머들이 주석을 엄격하게 관리해야 한다고, 그래서 복구성과 관련성과 정확성이 언제나 높아야 한다고 주장할지도 모르겠다. 하지만 나라면 코드를 깔끔하게 정리하고 표현력을 강화하는 방향으로, 그래서 애초에 주석이 필요 없는 방향으로 에너지를 쏟겠다. ... 그러므로 우리는 (간혹 필요할지라도) 주석을 가능한 줄이도록 꾸준히 노력해야 한다.

• 코드에 주석을 추가하는 일반적인 이유는 코드 품질이 나쁘기 때문이다. 모듈을 짜고 보니 짜임새가 엉망이고 알아먹기 어렵다. ... 그래서 자신에게 이렇게 말한다. “이런! 주석을 달아야겠다!” 아니다! 코드를 정리해야 한다! 코드로 의도를 표현하라!

• 어떤 주석은 필요하거나 유익하다. 하지만 정말로 좋은 주석은, 주석을 달지 않을 방법을 찾아낸 주석이다.

  • 법적인 주석(저작권정보, 소유권 정보 등)

  • 정보를 제공하는 주석 (때로는 유용하다 할지라도 코드에 정보를 담는 편이 더 좋다.)

  • 의도를 설명하는 주석

  • 의미를 명료하게 밝히는 주석

  • 결과를 경고하는 주석

  • TODO 주석

  • 중요성을 강조하는 주석

오늘 읽은 소감은? 떠오르는 생각을 가볍게 적어보세요

• 주석이 필요한 코드는 좋지 않은 코드라는 이야기가 박혀있어서 짜고보니 주석이 필요할 것 같은 내 실력 사이에서 현실적인 괴리를 느꼈었다. ‘주석은 필요악이다. 주석을 가능한 줄이도록 꾸준히 노력해야 한다.’라는 말이 깔끔하게 정리를 해준 느낌이다. 주석은 주석이 필요하지 않은 코드로 가는 단계인가보다.

궁금한 내용이 있거나, 잘 이해되지 않는 내용이 있다면 적어보세요.