오늘 TIL 3줄 요약

• 내 의도를 코드 안에서 주석 없이 구현하는 것이 최선이다.

• 좋은 주석의 예는 법률적 보호 범위에 대한 안내, 다른 개발자도 테스트 전에 알아야 할 경고, 다른 개발자에게 요청을 보내는 경우, 공용 API의 잘 쓰인 javadocs다.

• 나쁜 주석의 예는 이미 함수를 보고 알 수 있는 내용을 중복한 설명, 불필요한 정보, 공용 API용이 아닌 javadoc 등이 있다.

TIL (Today I Learned) 날짜

4/28/2022

오늘 읽은 범위

ch4. Comments

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

• (주석 없이) 코드 안에서 너의 의도를 통해 표현해라.

• 한 가지 일만 잘 하도록 설계된 짧은 함수에 그 역할을 드러내는 좋은 이름이 있다면 그것만으로 의도는 잘 전달된다.

• 나쁜 코드에 주석을 달아 부연하려 하지 말고, 아예 좋은 코드로 다시 써라!

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

• 읽는 독자의 입장에서 군더더기 없이 깔끔하게 읽히는 코드를 써야겠다.

• 내가 읽는 입장이 되었을 때 무엇이 핵심인지, 소음인지 파악해서 저자의 의도를 중심에 두고 다시 고쳐쓸 수 있다.