|| Clean Code || 아... 주석 달아도 되나...?

parfaite73·2022년 2월 25일
0

책 [Clean Code]를 읽고 정리한 내용입니다.

# 오늘 읽은 범위

4장. 주석

# 기억하고 싶은 내용

  • 우리에게 프로그래밍 언어를 치밀하게 사용해 의도를 표현할 능력이 있다면, 주석은 거의 필요하지 않으리라. 아니, 전혀 필요하지 않으리라. (p.68)
  • 진실은 한곳에만 존재한다. 바로 코드다. (p. 69)

- 주석은 나쁜 코드를 보완하지 못한다

  • 많은 경우 주석으로 달려는 설명을 함수로 만들어 표현해도 충분하다. (p.70)

- 좋은 주석

  • 법적인 주석
  • 결과를 경고하는 주석
  • TODO 주석
  • 중요성을 강조하는 주석

- 나쁜 주석

  • 일반적으로 대다수 주석은 허술한 코드를 지탱하거나, 엉성한 코드를 변영하거나, 미숙한 결정을 합리화하는 등 프로그래머가 주절거리는 독백에서 크게 벗어나지 못한다. (p.75)
  • 주석을 달기로 결정했다면 충분한 시간을 들여 최고의 주석을 달도록 노력한다. (p.76)
  • 이해가 안되어 다른 모듈까지 뒤져야 하는 주석은 독자와 제대로 소통하지 못하는 주석이다. 그런 주석은 바이트만 낭비할 뿐이다. (p.76)
  • 같은 이야기를 중복하는 주석
  • 오해의 여지가 있는 주석
  • 의무적으로 다는 주석
  • 함수나 변수로 표현할 수 있다면 주석을 달지 마라
  • 닫는 괄호에 다는 주석
  • 공로를 돌리거나 저자를 표시하는 주석
  • 주석으로 처리한 코드
  • HTML 주석
  • 전역 정보
  • 너무 많은 정보
  • 함수 헤더
  • 비공개 코드에서 Javadocs

# 떠오르는 생각

  • 회사에 와서 처음 코드리뷰를 받았을때 TODO 주석이랑 테스트를 위한 console.log를 지워달라는 코멘트를 받았다. 혼자 작업할때는 문제가 되지 않았던 것이라 미처 정리할 생각을 하지 못했던 것이다. 그리고 작업을 하다보면 레거시 코드에 남아있는 주석과 콘솔로그 때문에 검색결과가 불필요하게 길어지는 경우도 계속 보고 있다.
  • 레거시 코드를 보면서, 그리고 내가 코드를 짜면서 "이 부분에는 주석을 남기면 좋지 않을까"하는 생각이 종종 들곤 했다. 그런데 이 챕터를 읽고서는 "아차!" 싶었다. 주석을 쓰는데 리소스를 들이는 것 보다는 코드의 가독성을 높이는데 힘을 쓰는게 더 좋겠다는 생각이 들었다.

# 궁금 or 잘 이해되지 않는 내용

  • 자바 예제코드 역시 이해가 될 것 같다가도 잘 이해가 되지 않는다...
    다음에 클린코드 강의나 자바스크립트 클린코드 책을 읽어보고 싶다.
    자바스크립트 클린코드를 읽으면 뭔가 사이다를 마신 기분일듯 하다.
profile
Web Front-End Developer

0개의 댓글