읽은 범위: ~5장
3줄 요약
- 코드로 의도를 분명히 전달했다는 전제로, 좋은 주석은 정보를 전달하는 주석이다.
- 굳이 코드에 있는 내용을 주석으로 또 쓰지 않기.
- 써도 너무 길게 쓰지 않고 똑바로 쓰기.
느낀점, 생각
대부분 이 책에서는 주석을 사용하지 말라는 말이 강요되었습니다.
애초에 주석을 사용하지 말고 제대로 된 이름과 코드를 짜라는 의미겠죠.
주석이 있는 이유는 이 코드의 기능을 설명하는 것이 아니라, 정말 딱 필요한 정보만 입력하라고 있는 것 같습니다.
필요한 정보?
- 법적인 주석 (표준을 맞추기 위해 소스파일 첫머리에 저작권 정보와 소유권 정보.)
- 의미를 명료하게 밝히는 주석 ( 모호한 인수나 반환값은 그 의미를 읽기 좋게 표현하면 이해하기 쉬워짐.)
- 결과를 경고하는 주석 (오래 걸리는 테스트)
- TODO 주석 (앞으로 할 일)
주석은 이미 작업이 완료된 것들 위주보다는 다음 작업을 위해 적어야 하는 것 같다.
최애 BookTIL 3명
https://velog.io/@asuracoder/cleancode2
데빌 님
글도 잘 쓰시고 dart 코드로 공부하고 계셔서 제가 잘 읽을 수 있어요.
https://velog.io/@wonjang/%ED%81%B4%EB%A6%B0%EC%BD%94%EB%93%9C-%EB%A7%A4%EC%9D%BC-%EC%9D%BD%EA%B8%B0-TIL-3%EC%9E%A5.-%ED%95%A8%EC%88%98
원장 님
열심히 잘 정리해 주십니다. 잘 기록하시려고 노력하시는 게 보여요.
https://daehun.notion.site/TIL-4-of-22-3-e5d179d1ced94108a6d78d11762b397e
대훈 님
여러번 읽으셔서 그런지 이것저것 많이 알려주려고 하셔서 항상 감사합니다.
글 내용도 매번 잘 정리해 주셔서 좋아요.
그리고 그냥 나랑 읽으니까~ㅋ
부자가 되고 싶어요.