TIL (Today I Learned)
2022.05.09
오늘 읽은 범위
4장. 주석
책에서 기억하고 싶은 내용을 써보세요.
- 나쁜 코드에 주석을 달지 마라. 새로 짜라
- 우리는 코드로 의도를 표현하지 못해, 그러니까 실패를 만회하기 위해 주석을 사용한다.
- 특정 상황을 경고하거나, 중요 내용을 강조하는 주석은 좋은 주석일 수 있다.
- 앞으로 해야할 일에 대한 TODO주석을 달 수 있다 하지만 이는 최대한 빠르게, 그리고 주기적으로 확인하여 삭제하려 해야한다.
오늘 읽은 소감은? 떠오르는 생각을 가볍게 적어보세요
- 팀 혹은 개인 프로젝트를 진행하면서 주석에 대해서 잘못이해했다고 느꼈습니다.
- 주석은 엉망으로 짠 코드를 대변하는데 쓰이는것이 아니라 그 또한 유의미한 역할을 가지고 존재해야한다는 것을 깨달았습니다.
- TODO로 남겨두었던 주석들을 제거하는 하루가 되어야겠습니다.
궁금한 내용이 있거나, 잘 이해되지 않는 내용이 있다면 적어보세요.
- 언어의 문법에 위배되어서 변수, 함수 명을 피치못하게 작성했을때의 주석예시가 어떤게 있을지 고민해보려합니다.
오늘 읽은 다른사람의 TIL
https://nomadcoders.co/community/thread/9812
https://nomadcoders.co/community/thread/9809
https://nomadcoders.co/community/thread/9530
배움을 멈추지 않는 개발자, 박준우입니다.