더북(TheBook)

기본적으로 2.1 매직 넘버를 상수로 대체에서 보았던 방법을 적용했습니다. 이 방법으로 주석을 제거하고 상수명으로 합쳤습니다. 어쩌면 주석을 코드에 ‘임베딩’한 셈이죠.

이제 코드만으로 훨씬 더 많은 것을 알 수 있습니다. 상수 몇 개를 추가함으로써 가능했죠. 상수의 장점은 이름으로 의미를 드러낸다는 점입니다. 그러니 더 이상 주석으로 설명할 필요가 없습니다. 주석이 실제 코드로 변했습니다.

주석은 시간이 지나도 변하지 않을 위험성을 항상 내포합니다. 일반적으로 프로그래머는 코드만큼 주석에 엄격하지 않습니다. 코드는 바꾸어도 주석은 무시하거나 설명서 없이 새 변환률을 추가하기도 하죠.

이름 등으로 코드를 설명하면 코드 변경 시 무시할 일이 거의 없습니다. 경험상 주석을 상수나 변수, 필드, 메서드 이름으로 넣을 수 있다면 망설이지 말고 하세요!

신간 소식 구독하기
뉴스레터에 가입하시고 이메일로 신간 소식을 받아 보세요.