4장 주석

<aside> 💡 나쁜 코드에 주석을 달지 마라. 새로 짜라.

• 브라이언 W. 커니핸, P.J. 플라우거

</aside>

코드로 의도를 표현하지 못해 주석을 사용한다

주석은 오래될수록 코드에서 멀어지고, 주석을 유지 보수하기란 어려운 일이다

1 코드로 의도를 표현하라

좋은 주석은 주석을 달지 않는 것이 최선이다. 다음 두 코드를 비교해보면, 어떤 게 더 좋은 코드인지 짐작할 수 있다

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

if (employee.isEligibleForFullBenfits())

2 법적인 주석

회사가 정립한 구현 표준에 맞춰 법적인 이유로 특정 주석을 넣으라고 명시한다

→ 각 소스 파일 첫머리에 저작권 정보와 소유권 정보는 필요하다

→ Fitness에서 추가한 표준 주석 헤더(IDE가 자동으로 해준다)

3 정보를 제공하는 주석

추상메서드가 반환할 값을 설명해줄 때 사용한다

// KK:MM:SS EEE, MMM dd, yyyy 형식
Pattern timeMatcher = Pattern.compile(
	"\\\\d*:\\\\d*:\\\\d* \\\\w*, \\\\w* \\\\d*, \\\\d*");

4 의미를 명료하게 밝히는 주석