Community

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

← Go back
TIL. 4장 주석
by kaye
#clean_code
2년 전
263

오늘 TIL 3줄 요약

  • 나쁜 코드에 주석을 달지 마라. 새로 짜라. -브라이언 W. 커니헨, P.J.플라우거

  • 주석은 언제나 실패를 의미한다.

TIL (Today I Learned) 날짜

2022. 04.29

오늘 읽은 범위

4장. 주석

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

  • 자신이 저지른 난장판을 주석으로 설명하려 애쓰는 대신에 그 난장판을 깨끗히 치우는 데 시간을 보내라! (p.69)

  • 좋은 주석

--> 법적인 주석

--> 정보를 제공하는 주석

--> 의도를 설명하는 주석

--> 의미를 명료하게 밝히는 주석

--> 결과를 경고하는 주석

--> TODO 주석

--> 중요성을 강조하는 주석

  • 나쁜주석

--> 주절거리는 주석

--> 같은 이야기를 중복하는 주석

--> 오해할 여지가 있는 주석

--> 의무적으로 다는 주석

--> 이력을 기록하는 주석

--> 있으나 마나 한 주석

--> 함수나 변수로 표현할 수 있다면 주석을 달지 마라

--> 닫는 괄호에 다는 주석

--> 공로를 돌리거나 저자를 표현하는 주석

--> 주석으로 처리한 코드

--> HTML 주석

--> 전역 정보

--> 너무 많은 정보

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

사실 오늘 장을 가장 잘 표현하는 것은 이 문장이라고 생각한다.

'자신이 저지른 난장판을 주석으로 설명하려 애쓰는 대신에 그 난장판을 깨끗히 치우는 데 시간을 보내라!'

...네, 아빠!🥲