Community

개발자 99% 커뮤니티에서 수다 떨어요!

← Go back
TIL-4. 주석
by xing
#clean_code
2년 전
614


TIL (Today I Learned)

2022.02.25

오늘 읽은 범위

4장. 주석

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

  • 주석은 언제나 실패를 의미한다. (p.68)

  • 코드로 의도를 표현해야 하며, 주석을 달 때마다 자신에게 표현력이 없다는 사실을 푸념해라. (p.68)

  • 코드로 의도 표현! -> 함수 이름에 정보 담기. (p.71)

  • TODO 주석 - 앞으로 할 일 남겨두기 (p.74)

  • 함수나 변수로 표현할 수 있다면 주석을 달지 마라. (p.84)

내가 작성하던 나쁜 주석

  • 위치를 표시하는 주석 - 슬래시(/) 잡음.. 가독성만 낮춤.

  • 닫는 괄호에 다는 주석 - 주석 달지말고 함수를 줄이려 노력.

  • 주석으로 처리한 코드 - 소스 코드 관리 시스템이 다 기억해준다. 망설이지 말고 삭제해라!

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

  • 4장 마지막 부분에 목록 4-7 코드와 그것을 리팩터링한 4-8 코드. 확실히 4-8이 좋은 코드 같았다.

  • 4-7은 내가 달던 주석 그 자체였다. 필요없는 주절주절한 주석을 잔뜩 달아야 이해하기 쉽다고 여겼던 것 같다. 앞으로는 그럴 시간에 코드에 의미를 담도록 해야겠다.

  • 코드를 주석으로 처리한 경험이 많은데,, 소스 코드 관리 시스템이 다 기억해주니 걱정말고 삭제하라는 말이 인상깊었다. ㅜㅜ

  • 난 표현력이 없었단 사실을 푸념했다.

궁금한 내용이 있거나, 잘 이해되지 않는 내용이 있다면 적어보세요.

  • Javadocs