📖 220129_클린코드_DAY06

📖 읽은 범위

4 주석 (p.67 ~ p.94)

🧠 책에서 기억하고 싶은 내용

• 주석이 오래될수록 코드에서 멀어진다. 오래될수록 완전히 그릇될 가능성도 커진다. 이유는 단순하다. 프로그래머들이 주석을 유지하고 보수하기란 현실적으로 불가능하니까.
• 표현력이 풍부하고 깔끔하며 주석이 거의 없는 코드가, 복잡하고 어수선하며 주석이 많이 달린 코드보다 훨씬 좋다.
• 의도를 설명하거나, 결과를 경고하거나, 현재 테스트 중이라고 표시할 때 등에서만 쓰여야 한다.
• 있으나 마나 한 주석을 달려는 유혹에서 벗어나 코드를 정리하라. 더 낫고, 행복한 프로그래머가 되는 지름길이다.
• 함수나 변수로 표현할 수 있다면 주석을 달지 마라
• 저자 이름으로 코드를 오염시킬 필요가 없다. 다시 한 번 강조하지만, 위와 같은 정보는 소스 코드 관리 시스템에 저장하는 편이 좋다.
• 주석으로 처리한 코드만큼 밉살스러운 관행도 드물다.

🤔 읽은 소감 및 떠오르는 생각

다음 코드 예제 두 개를 살펴보자. 어느 쪽이 더 나은가?

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

이 부분을 보고 나서 나는 너무 놀랐고 신기했다. 이 예제를 통해 작가가 의도하는 방식이 어떤 식으로 의미하는지를 확실히 알게 되었고, 진짜 모든 것은 최대한 짧게 작성해야 함을 눈으로 보며 알게 되었다. 그동안 나는 if문에서 여러 개를 비교할 때 저런 방식으로 코드를 작성했기 때문이다. 왜 한번에 함수화 할 생각을 하지 못했던걸까?

• 이력을 기록하는 주석이나 너무나 당연한 내용의 주석은 작성하지 말도록 하자.
  ➡️ 그동안 나는 노마드코더 공부든, 자바 공부든 예제를 공부할 때 향후 내가 복습할 때 더 쉽게 이해하기 위해 당연한 내용의 주석을 작성하곤 했었다. 지금 생각해보니, 더 직관적으로 코드의 의미가 어떤 뜻인지를 파악할 수 있도록 작성한다면 애초에 주석을 달아놓을 일이 없는 것이었다. 앞으로는 공부할 때 내가 이해할 수 있는 이름으로 작성하는 습관을 들여놓아야겠다고 깨닫게 되었다.

🔎 궁금하거나 이해되지 않는 내용

✍🏻 소감 3줄 요약

• 그동안 내가 작성했던 모든 코드들은 더러운 코드들이었다.
• 이번에 예제로 나온 코드들을 보면서 저자가 생각하는 클린 코드란 무엇인가에 조금은 알 것 같이 느껴졌다.
• 앞으로, 주석이 필요 없을 정도로 코드를 깔끔하게 작성해보려고 해 보자. 주석이 있다는 것은 결국 추가 설명이 있어야만 코드를 이해할 수 있다는 뜻이다.