Community

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

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


TIL (Today I Learned)

2022.02.24 ~ 02.25

오늘 읽은 범위

4장. 주석

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

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

- 프로그래밍 언어 자체가 표현력이 풍부하다면, 아니 우리에게 프로그래밍 언어를 치밀하게 사용해 의도를 표현할 능력이 있다면, 주석은 거의 필요하지 않으리라. 아니, 전혀 필요하지 않으리라. (p.68)

  • 주석은 나쁜 코드를 보완하지 못한다

- 표현력이 풍부하고 깔끔하며 주석이 거의 없는 코드가, 복잡하고 어수선하며 주석이 많이 달린 코드보다 훨씬 좋다. 자신이 저지른 난장판을 주석으로 설명하려 애쓰는 대신에 그 난장판을 깨끗이 치우는 데 시간을 보내라! (p.69)

  • 나쁜 주석

- 주석과 주석이 설명하는 코드는 둘 사이 관계가 명백해야 한다. 이왕 공들여 주석을 달았다면 적어도 독자가 주석과 코드를 읽어보고 무슨 소린지 알아야 하지 않겠는가? (p.89)

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

여러 개의 주석보다 한 개의 좋은 함수 이름이 더 효율적이다.

항상 주석이 필요하다 생각해서 주석을 자주 썼는데 앞으로는 함수 이름을 더 고민해서 지어야겠다.

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