TIL (Today I Learned) 날짜

2024.01.30-2024.01.31

오늘 읽은 범위

4장 주석

3줄 요약

• 잘 달린 주석은 그 어떤 정보보다 유용하다.

• 부정확한 주석은 아예 없는 주석보다 훨씬 더 나쁘다.

• 주석을 가능한 줄이도록 꾸준히 노력하자.

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

• 코드에 주석을 추가하는 일반적인 이유는 코드 품질이 나쁘기 때문이다.

• 법적인 주석, 정보를 제공하는 주석, 의도를 설명하는 주석, 의미를 명료하게 밝히는 주석, 결과를 경고하는 주석, 중요성을 강조하는 주석

• 주절거리는 주석, 같은 이야기를 반복하는 주석, 오해할 여지가 있는 주석, 의무적으로 다는 주석, 있으나 마나한 주석, 이력을 기록하는 주석

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

- 업무를 하면서 혹여나 다른사람이 나의 코드에 대해 이해를 못할까봐 주석을 여기저기 달아놓은적이 많았는데 이 책을 통해 나의 코드가 품질이 나쁘기 때문에 주석을 필연적으로 기입했던거 같습니다. 좀 더 명확하게 함수나 변수명이 개선과 리팩토링을 통해 명확하고 이해하기 쉽게 코드를 짜는 연습을 많이 해야겠습니다.

오늘 읽은 다른사람의 TIL

• kyj732422님의 TIL - (https://nomadcoders.co/community/thread/9220)

• frontend16님의 TIL - (https://nomadcoders.co/community/thread/9221)