오늘 TIL 3줄 요약

• 좋은 주석은 유용하고 필요하지만, 가능하면 주석이 필요하지 않도록 코드를 개선하는게 낫다.

• 좋은 주석이란 법, 정보, 의도, 의미, 결과에 대한 경고, 해야할 일, 중요성, 공개API용 docs에 대한 정보를 담고 있는 주석이다.

• 나쁜 주석은 작성자만 아는 내용을 주절거리거나, 같은 이야기의 중복이거나, 오해의 여지가 있거나, 의무적으로 달거나, 이력을 기록하거나, 있으나마나한 내용을 기록하는 주석이다.

TIL (Today I Learned) 날짜

2022.04.30

오늘 읽은 범위

4장. 주석

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

• 때때로 주석은 결정에 따른 의도까지 설명한다.

• 다른 프로그래머에게 결과에 대해 경고할 목적으로 주석을 사용한다.

• 이해가 안되어 다른 모듈까지 살펴봐야하는 주석은 독자와 소통하지 못하는 주석이다.

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

• 그동안 코드를 작성하면서 작성자만 알 수 있는 내용을 주석으로 주절거리지 않았는지 걱정이 된다.

• 주석은 꼭 필요한 경우에만 달고, 나쁜 주석을 달지 않도록 주의해야겠다.

궁금한 내용이 있거나, 잘 이해되지 않는 내용이 있다면 적어보세요.

오늘 읽은 다른사람의 TIL

• xxheeok님의 TIL (https://ho-im.tistory.com/11)