TIL

Chapter 15 불필요한 주석 지우기

• 코드만으로 내용을 모두 이해할 수 있다면 주석은 삭제하라
• 주석과 코드는 시간이 흐르면 맞지 않는 경우가 있다.
  • 코드가 변경되면 원래 주석이 불필요해질 수 있다.
• 필요 없는 주석은 혜택은 없고 비용만 발생시킬 뿐이다.
  • ex) 코드와 주석이 중복인 경우
• 코드 정리는 종종 연결되어 있다.

if (generator) {
  println("generator 설정 코드 호출")  
} else {
  // generator가 없다면 default 반환
  return getDefaultGenerator()
}

• 조건절 보후 구문을 적용하면 다음과 같이 바뀐다.

if (!generator) {
  // generator가 없다면 default 반환
  return getDefaultGenerator()
} 

println("generator 설정 코드 호출")

• 처음부터 주석이 중복된 것은 아니였지만 바뀐 코드에서는 코드와 주석이 중복된다.
  • if(!generator) return getDefaultGenerator() == // generator가 없다면 default 반환
  • 그러니 삭제하면 된다.