클린 코드(Clean code) Day 4

 

 

🔖오늘 읽은 범위 : 4장 주석

---

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

 

우리는 코드로 의도를 표현하지 못해, 그러니까 실패를 만회하기 위해 주석을 사용한다.

 

 

 

 

함수나 변수로 표현할 수 있다면 주석을 달지 말자.

 

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

위의 코드는 충분히 주석 없이도 표현이 가능하다.

if(employee.isEligibleForFullBenefits())

이렇게.

 

 

그럼에도 괜찮은 주석

•  정보를 제공하는 주석

// HH:mm:ss, MM dd, yyyy 형식
Pattern timeMatcher = Pattern.compile(
	"\\d*:\\d*:\\d*, \\w* \\d*, \\d*");

 

• 의도를 설명하는 주석
• 중요성을 강조하는 주석 ( 자칫 대수롭지 않다고 여겨지는 부분의 중요성을 강조하기 위해 사용)

 

 

 

 

 

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

 

주석이 줄줄이 달려있다고 친절한 코드가 아니다. 

주석에 의존하려는 습관을 버리자. 주석보다는 변수 또는 함수의 이름으로 역할을 나타내기.

 

하지만 과연 한글로 써진 주석보다 영어로 길게 표현된 함수명이 우리에게 효율적인가?)