Community

개발자 99% 커뮤니티에서 수다 떨어요!

← Go back
TIL 4장. 주석
#clean_code
2년 전
509


TIL (Today I Learned)

2022.02.24

오늘 읽은 범위

4장. 주석

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

  • 나쁜 코드에 주석을 달지 말. 새로 짜라. - 브라이언 W. 커니핸, P.J.플라우거 (p.68)

  • 주석은 오래될수록 코드에서 멀어진다. 오래될수록 완전히 그릇될 가능성도 커진다. 이유는 단순하다. 프로그래머들이 주석을 유지하고 보수하기란 현실적으로 불가능하니까. (p.68)

  • 코드만이 정확한 정보를 제공하는 유일한 출처다. 그러므로 우리는 (간혹 필요할지라도) 주석을 가능한 줄이도록 꾸준히 노력해야 한다. (p.69)

  • 표현력이 풍부하고 깔끔하며 주석이 거의 없는 코드가, 복잡하고 어수선하며 주석이 많이 달린 코드보다 훨씬 좋다. (p.69)

  • 주석이 올바른지 검증하기 쉽지 않다. 이것이 의미를 명료히 밝히는 주석이 필요한 이유인 동시에 주석이 위험한 이유이기도 하다. (p.73)

  • 이해가 안되어 다른 모듈까지 뒤져야 하는 주석은 독자와 제대로 소통하지 못하는 주석이다. 그런 주석은 바이트를 낭비할 뿐이다. (p.76)

  • 주석이 코드보다 더 많은 정보를 제공하지 못한다. 코드를 정당화하는 주석도 아니고, 의도나 근거를 설명하는 주석도 아니다. 코드보다 읽기가 쉽지도 않다. 실제로 코드보다 부정확해 독자가 함수를 대충 이해하고 넘어가게 만든다. (p.77)

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

  • 사실 프로젝트를 할 때 주석을 잘 다는 편은 아니다. 그렇다고 코드를 잘 짜기라도 하냐? 그것도 아니다. 이 코드를 (혹은 변수) 왜 썼는지 확인하기 위해 함수의 함수를 거슬러 올라가 읽은 적이 한두번이 아니었다. 주석도 마찬가지일 것이다. 아직은 주석을 달고 다시 확인해보는 일이 없지만 사람 일은 어떻게 될 지 모른다. 지금부터라도 작성하는 코드에 주석이 필요한 경우가 생기면 오늘 읽은 책을 명심하면서 주석을 달 수 있도록 해야겠다.

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