#노마드북클럽 | 클린 코드 (Clean Code) 6일차

TIL (DAY 6)

🔖 오늘 읽은 범위: 4장, 주석

---

책에서 기억하고 싶은 내용

• 나쁜 코드에 주석을 달지 마라. 새로 짜라. (p68)
• 주석은 언제나 실패를 의미한다. 때때로 주석 없이는 자신을 표현할 방법을 찾지 못해 할 수 없이 주석을 사용한다. (p68)
• 진실은 한곳에만 존재한다. 바로 코드다. (p69)
• 좋은 주석:
  • 법적인 주석
  • 정보를 제공하는 주석
  • 의도를 설명하는 주석
  • 의미를 명료하게 밝히는 주석
  • 결과를 경고하는 주석
  • TODO 주석
  • 중요성을 강조하는 주석
• 이해가 안 되어 다른 모듈까지 뒤져야 하는 주석은 독자와 제대로 소통하지 못하는 주석이다. 그런 주석은 바이트만 낭비할 뿐이다. (p76)

오늘 읽은 소감 및 생각

• 변수명이 길고 서술적이거나, 긴 class 오브젝트를 위한 주석은, 코드를 다 읽지 않고도 코드 전체에 대한 general idea를 파악할 수 있다는 점에서, '제대로 유지보수 되고 있다는 전제 하에' 주석을 참고하는 것이 많은 도움이 되었다.
• 실제로 지금까지 들었던 객체 지향 언어 수업에서는 교수님이 깨끗한 코드를 쓰는 법에 대해 수업을 해주시기도 했는데, javadoc 이나 docstring의 중요성을 엄청 강조하셨다. 하지만 돌이켜 생각해보니 주절거리거나 코드를 그대로 '해석'하는 주석들, 말그대로 '의무적으로 다는 주석'들을 써온 것 같다. 그 주석들을 토대로 코드를 더 깔끔하게 업데이트 하던지, 필요한 곳에만 '좋은' 주석을 만들던지 앞으로 코드를 짤 때 많은 고민들이 생길 것 같다.
• 닫는 괄호에 여기까지가 'while' 블록이었어, 여기까지가 'try' 블록이었어 라며 주석을 다는 사람이 있다는 걸 처음 알았다. 이건 진짜 사족이다 😂
• 깃과 깃헙이 등장함으로써 코드가 더 깨끗해질 수 있음에 감사하다. 그렇지 않았으면 우리가 푸시하는 commit message들이 모두 주석화되었을지도 모르는데 ㅠㅠ

궁금한 내용이나 새로 알게 된 개념

• JUnit4가 나오기 전에 메서드 이름 앞에 _ 를 넣음으로써 테스트 케이스를 꺼버릴 수 있었다는 사실.
• 정적 초기화 (static initialization)
  : 정적 블록 (static block)은 클래스가 로딩될 때 호출되며 각 클래스당 최초 1회만 실행. (출처)
• TODO 주석
  : 얼마 전에 TODO 익스텐션이 있다는 것을 알게 되었다. 코드에 업데이트가 필요하거나, 수정이나 삭제가 필요한 경우 TODO 주석을 달아놓으면 한 눈에 어떤 To Do task 들이 있는지 보여주는 확장 프로그램이었다. 앞으로도 꽤 유용하게 쓸 것 같다.