[Clean Code] 4장. 주석

TIL (Today I Learned)

2022.02.26

 

오늘 읽은 범위

4장. 주석

 

 

 

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

• 주석은 오래될수록 코드에서 멀어진다. 오래될수록 완전히 그릇될 가능성도 커진다. 이유는 단순하다. 프로그래머들이 주석을 유지하고 보수하기란 현실적으로 불가능하니까. (p.68)

---

• 코드로 의도를 표현하라! (p.70)

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

if (employee.isEligibleForFullBenefits())

---

public static SimpleDateFormat makeStandardHttpDateFormat()
{
  //SimpleDateFormat은 스레드에 안전하지 못하다.
  //따라서 각 인스턴스를 독립적으로 생성해야 한다.
  SimpleDateFormat df = new SimpleDateFormat("EEE, dd MMM yyyy HH:mm:ss z");
  df.setTimeZone(TimeZone.getTimeZone("GMT"));
  return df;
}

• 하지만 여기서는 주석이 아주 합리적이다. 프로그램 효율을 높이기 위해 정적 초기화 함수를 사용하려던 열성적인 프로그래머가 주석 때문에 실수를 면한다. (p.74)

---

 

 

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

사실 나는 평소에도 주석 다는 것을 별로 선호하지 않았다. 설명이 필요 없을 정도의 좋은 코드를 잘 짜서가 아니라, 코드와 달리 가독성이 떨어지는 경험을 몇 번 했어서 그랬다. 주석은 대충 보고 넘기거나, 공을 들여 애써 읽거나 둘 중 하나인 경우가 많았다.
이번 챕터에서 저자는 대부분의 주석은 쓸모 없음을 강조하는 동시에 어떨 때 사용하면 좋은지를 명시해 주었다. 덕분에 더 명확히 주석의 중요성을 느낄 수 있었다. 주석은 적재적소에 쓰여야 그 효과를 제대로 발휘한다! 

 

 

 

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

• Javadocs
• 필터 바이트