Community

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

← Go back
TIL. 4장 주석 ( 2022.02.24 ~ 2022.02.25 )
#clean_code
2년 전
600

TIL (Today I Learned)

2022.02.24 ~ 2022.02.25

오늘 읽은 범위

4장. 주석

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

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

  • 주석을 달기로 결정했다면 충분한 시간을 들여 최고의 주석을 달도록 노력한다. (p.78)

  • 모든 함수에 Javadocs를 달거나 모든 변수에 주석을 달아야 한다는 규칙은 어리석기 그지없다. (p.80)

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

  • 이 장을 읽기 전에도 주석을 달지 않고 코드 자체에 의미를 담으려고 노력을 했었다. 하지만 그 노력을 더 해야겠다는 생각이 들었다.

  • 이 장을 읽고 내 코드를 보았다. 역시 이 장에서 말했듯 전혀 필요없는 주석이었다. 주석을 달기로 결정했으면 신중히 고민하고 달아야겠다.

  • 내 주석들은 함수가 작게 나눠져 있지 않다는 것을 보여주는 것 같았다... 주석이 있다면 여지없이 함수가 작게 나눠져 있지 않았기 때문이다.

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