[Clean Code/클린 코드] 4장 주석

4장 주석

📖  나쁜 코드에 주석을 달지 마라. 새로 짜라.

 

 

목차

 

---

🗒️ 책에서 기억하고 싶은 내용

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

코드에 주석을 추가하는 일반적인 이유는 코드 품질이 나쁘기 때문이다.

코드로 의도를 표현하라!

// 직원에게 복지 혜택을 받을 자격이 있는지 검사한다.
if ((employee.flags & HOURLY_FLAG) && (employee.age > 65))

 

if (employee.isEligibleForFulBenefits())

몇 초만 더 생각하면 코드로 대다수 의도를 표현할 수 있다.

예제

p.90~94
목록 4-7을 리팩터링한 결과인 4-8을 비교해서 볼 것

 

🗒️ 소감

챕터 1~3을 읽으며 코드를 작성하는 습관을 고치려고 노력했다.

한눈에 알아볼 수 있도록 변수와 함수의 이름을 바꾸었더니 주석의 수가 줄었다.

이러한 경험을 토대로 저자가 주석을 부정적으로 보는 이유를 이해할 수 있었다.

 

🗒️ 궁금하거나 어려웠던 내용

X