Community

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

← Go back
day6. TIL(주석)
#clean_code
2년 전
409


TIL (Today I Learned)

2022.02.24 ~ 25

오늘 읽은 범위

4장. 주석

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

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

  • 우리는 코드로 의도를 표현하지 못해, 그러니까 실패를 만회하기 위해 주석을 사용한다. 주석은 언제나 실패를 의미한다. 그러므로 주석이 필요한 상황에 처하면 곰곰이 생각하기 바란다. 상황을 역전해 코드로 의도를 표현할 방법은 없을까?(p.68)

  • 주석은 나쁜 코드를 보완하지 못한다. 코드에 주석을 추가하는 일반적인 이유는 코드 품질이 나쁘기 때문이다. 표현력이 풍부하고 깔끔하며 주석이 거의 없는 코드가, 복작하고 어수선하며 주석이 많이 달린 코드보다 훨씬 좋다.(p.69)

  • 코드로 의도를 표현하라!(p.70)

  • 좋은 주석. 정말로 좋은 주석은, 주석을 달지 않는 방법을 찾아낸 주석이라는 사실을!(p.70)

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

  • 주석 파트는 거의 20페이지에 걸쳐 주석을 최대한 사용하지 말라고 설득한다. 좋은 주석은 법적인 이유, 의도를 설명하기 위해, 인수나 반환값이 표준라이브러리나 변경하지 못하는 코드여서 의미를 명료하게 해야 할 때, 결과를 경고할 때, 앞으로 할 일을 일시적으로 표현할 때, 중요성을 강조할 때 정도로 5~6경우 정도로 추려진다. 이 말은 되도록이면 코드로 잘 표현하고 주석은 사용하지 말라는 의미가 된다.

  • 정말 필요한 경우에만 주석을 사용하라는 말에 동의하는게 프로그래밍을 공부하는 초반에는 주석도 많이 달고 했었다. 돌이켜보면 이 코드가 동작하는 원리에 대해 아직 익숙하지 않아서 공부 목적으로 달은 경우가 많았다. 나중에 다시 보면 불필요한 주석이었고, 가독성이 떨어진다고 느껴지는 경우가 많았다. 주석을 달아야 할 상황이 온다면 먼저 코드를 개선하려고 노력할 것이다.

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