TIL(Today I Learned) 🧑🏻‍💻

4. 주석

내용 정리 & 기억하고 싶은 내용

• 우리는 코드로 의도를 표현하지 못해, 그러니까 '실패'를 만회하기 위해 주석을 사용한다. 주석은 오래될수록 코드에서 멀어진다. <p.68>

• 진실은 한곳에만 존재한다. 바로 '코드'다. 코드만이 자기가 하는 일을 진실되게 말한다. 코드만이 정확한 정보를 제공하는 유일한 출처다. <p.69>

• 주석은 나쁜 코드를 보완하지 못한다. 자신이 저지른 난장판을 주석으로 설명하려 애쓰는 대신에 그 난장판을 깨끗이 치우는 데 시간을 보내라! <p.69>

  1. 주석이 있는 코드

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

  2. 주석이 없는 코드

  if (employee.isEligibleForFullBenefits())

• 좋은 주석

  1. 법적인 주석

  2. 정보를 제공하는 주석 ( 가능하면 클래스나 함수 이름에 정보를 담는다. )

  3. 의도를 설명하는 주석

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

  5. 결과를 경고하는 주석

  6. TODO 주석

  7. 중요성을 강조하는 주석

• 나쁜 주석

  1. 주절거리는 주석

  2. 같은 이야기를 중복하는 주석

  3. 오해할 여지가 있는 주석

  4. 의무적으로 다는 주석

  5. 이력을 기록하는 주석 ( 소스 코드 관리 시스템으로 대체 )

  6. 있으나 마나 한 주석

  7. 함수나 변수로 표현할 수 있다면 주석을 달지 마라.

  8. 위치를 표시하는 주석

  9. 닫는 괄호에 다는 주석

  10. 공로를 돌리거나 저자를 표시하는 주석

  11. 주석으로 처리한 코드

  12. HTML 주석

  13. 전역 정보

  14. 너무 많은 정보

  15. 모호한 관계

  16. 함수 헤더

생각 & 느낀점 📝

• 적절한 주석을 사용하는 것은 좋은 코드를 짜는 것 만큼이나 어렵다는 것을 깨달았다. 나의 편의를 위해, 좋지 않던 코드들을 합리화 하기 위해 써왔던 주석들이 떠올랐다. 전부 좋지 못한 주석의 예시에 언급되었던 것들이다.

• 하지만 주석 사용에 대해서는 여전히 여러 논쟁이 이어지고 있는 것 같다.

• 좋은 코드는 점점 이해가 되어가지만 좋은 주석은 점점 어려워지는 것 같다. 클린 코드를 다 읽으면 클린 코맨트라도 찾아야하는걸까?

새로 용어 정리

참고 문헌