[클린코드 읽기 챌린지] 220428~220429 4장 주석

[클린코드 읽기 챌린지] 220428~220429 4장 주석

오늘의 과제

• 4장 주석 읽기

책에서 기억하고 싶은 내용을 써보세요.

• 우리는 코드로 의도를 표현하지 못해, 그러니까 실패를 만회하기 위해 주석을 사용한다. (p.68)
• 좋은 주석
  • 법적인 주석
  • 정보를 제공하는 주석
  • 의도를 설명하는 주석
  • 의미를 명료하게 밝히는 주석
  • 결과를 경고하는 주석
  • TODO 주석
  • 중요성을 강조하는 주석
• 나쁜 주석
  • 주절거리는 주석
  • 같은 이야기를 중복하는 주석
  • 오해할 여지가 있는 주석
  • 의무적으로 다는 주석
  • 이력을 기록하는 주석 (소스 코드 관리 시스템을 활용)
  • 있으나 마나 한 주석
  • 닫는 괄호에 다는 주석
  • 공로를 돌리거나 저자를 표시하는 주석 (소스 코드 관리 시스템을 활용)
  • 주석으로 처리한 코드 (소스 코드 관리 시스템을 활용)
• 함수나 변수로 표현할 수 있다면 주석을 달지 마라 (아래가 더 좋은 코드이다)

// 전역 목록 <smodule>에 속하는 모듈이 우리가 속한 하위 시스템에 의존하는가?
if (smodule.getDependSubsystems().contains(subSysMod.getSubSystem()))

ArrayList moduleDependees = smodule.getDependSubsystems();
String ourSubSystem  subSysMod.getSubSystem();
if (moduleDependees.contains(ourSubSystem))

오늘 읽은 소감은? 떠오르는 생각을 가볍게 적어보세요

사실 의미없는 주석을 줄이거나 효율적으로 쓰는 등 주석을 어떻게 쓸지를 고민해 볼 기회가 없었던 것 같다. 특히나 코드 한 줄씩 읽어가며 주석을 쓰던 습관을 없애고 최대한 함축적으로 블록 앞이나 함수 앞에 써야겠다고 생각했다.🧨