개발자 99% 커뮤니티에서 수다 떨어요!
오늘 TIL 3줄 요약
<예시>
주석이 필요하지 않게 코드를 적는 것이 중요하다
주석이 정말 필요한 곳 말고는 안쓰는게 낫다.
결국 코딩을 더 잘해야 하는 것
TIL (Today I Learned) 날짜
2022. 04.29 금
오늘 읽은 범위
4장. 주석
책에서 기억하고 싶은 내용을 써보세요.
코드는 변화하고 진화한다. 하지만 주석은 언제나 코드를 따라가지 않는다. 결국 주석은 코드에서 분리되어 점점 더 부정확한 고아로 변한다.
코드로 의도를 표현하라. 많은 경우 주석으로 달리는 설명을 함수로 만들어 표현해도 충분하다.
주절거리고 반복되는 주석을 적지 마라. 이해가 안되어 다른 모듈까지 뒤져야 하는 주석은 독자와 제대로 소통하지 못하는 주석이다.
오늘 읽은 소감은? 떠오르는 생각을 가볍게 적어보세요
코딩 작업을 하면서 함수에 여러가지 작업을 기술해놓고 주석으로 적을 때가 많았었다. 페이징 리스트를 실행하면 DB를 호출하고 모델 선언 후 멤버 변수마다 데이터를 할당하는 등 많은 코드를 쓰고 주석으로 떼울 때가 많았다. 직관성있고 보기 쉬운 코드를 쓰는게 중요하다는 메인 주제로 4장까지 같은 흐름으로 이어져오는 것 같다.