Community

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

← Go back
TIL 0225 4.주석
#clean_code
2년 전
432


TIL (Today I Learned)

2022.02.25

오늘 읽은 범위

4장 주석

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

  • 나쁜 코드에 주석을 달지 마라. 새로 짜라

  • 주석이 필요한 상황에 처하면 곰곰히 생각하기 바란다. 상황을 역전해 코드로 의도로 표현할 방법은 없을까? 코드로 의도를 표현할 때마다 스스로를 칭찬해준다.

  • 코드만이 자기가 하는 일을 진실되게 말한다.

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

  • 몇 초만 더 생각하면 코드로 대다수 의도를 표현할 수 있다.

  • 주석을 써도 괜찮은 경우가 있음. 좋은 주석: 법적인 주석, 정보를 제공하는 주석, 의도를 설명하는 주석, 의미를 명료하게 밝히는 주석, 결과를 경고하는 주석, ToDo 주석, 중요성을 강조하는 주석

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

늘 내코드를 보는 사람이 "이걸 이해 못 하면 어떡하지?"라는 생각에 구구절절 주석을 달았는데 그럴 시간에 차라리 코드를 새로 짜는게 더 나은 프로그래머라는걸 깨달았다.

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

예시로 적힌 코드는 어떤 언어일까? 봐도 이해가 안 된다.