노마드코더 개발자북클럽 Clean code TIL 4 : 4장 주석
오늘 TIL 3줄 요약
결과를 경고하는 주석은 적절하다.
표준 라이브러리나
프로그래머가 직접 변경할 수 없는 코드라면
의미를 명료하게 밝히는 주석이 유용하다.되도록이면, 주석이 필요없는,
의도가 명확하게 표현된 코드를 짠다.
TIL (Today I Learned) 날짜
2025. 05. 28
오늘 읽은 범위
4장. 주석
기억하고 싶은 내용을 써보세요.
- 법적인 이유로 특정 주석을 넣기가 강제되는 경우, 타당한 주석이다.
(저작권 정보, 소유권 정보) - 이해가 되지 않아 다른 모듈까지 뒤져야 하는 주석은
독자와 제대로 소통하지 않는 주석이다. - 코드와 같은 이야기를
중복으로 설명하는 주석을 달지 말자.
(함수나 변수와 같은 코드를
또 다시 주석으로 달 필요는 없다.)
지나친 참견의 주석이 많이 있다면,
정작 필요한 주석을 개발자가 무시할 수 있다. - 현대에는 VCS, 버전 관리 시스템의 등장으로,
이력을 기록하는 주석을 달 필요가 없어졌으며
저자 또한 기록할 필요가 없다. - 위치를 표시하기 위한 주석
//// ####
을 지양하자. - 주석으로 처리한 코드는
소스 코드 관리 시스템이 대신 코드를 기억해주기기 때문에
지우기를 주저하지 말자. - 너무 많은 기술적, 역사적인 정보를 첨부하지 않기.
- 모호한 주석으로
주석 자체가 다시 설명을 요구한다면, 좋지 않은 주석이다. - 코드 일부에 전역적인 정보에 대한 주석을 달지 않는다.
오늘 읽은 소감은? 떠오르는 생각을 가볍게 적어보세요
TODO 주석을 적극적으로 활용하여 개발팀과 소통해야겠다.
함수 + 인수에 대한 정보를 주석으로 제시하기보다,
함수, 인수를 "잘" 명명하자.
궁금한 내용이 있거나, 잘 이해되지 않는 내용이 있다면 적어보세요.
댓글
댓글 쓰기