DAY 9

🔖 오늘 읽은 범위 : 4장. 주석 (p.81 ~ 94)

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

</aside>

• 소스 파일에서 특정 위치를 표시하는 주석(”// Action ///////////////////”)은 아주 드물게 사용하는 편이 좋다. (p. 85)
• 주석으로 처리한 코드는 소스코드 관리 시스템이 기억해주므로 필요없다. 삭제하라 (p.87)
• 주석 자체가 다시 설명을 요구하는 경우는 없어야한다. (p.89)

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

</aside>

소스 파일에서 특정 위치를 표시하는 주석을 꽤 사용했었다. 써도 된다니 쓰고있는대로 적당히 써야겠다. 주석으로 처리한 코드도 꽤 사용했는데 이제 사용하지 말아야겠다. 그 정보가 필요하면 히스토리를 보면 되니 말이다.

주석 자체가 설명을 요구하는 (히스토리를 알아야 이해가능한) 주석을 사용한 적이 있었다. 앞으로는 설명이 소스에 녹아들도록 작성하는데 노력해야겠다.

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

</aside>

기록하신 TIL을 공유해주세요 - TIL 출석표

클린코드_스케쥴러_TIL 출석표 (노개북1기)

소감 3줄 요약

• 특정 위치를 표시하는 주석 // Action ////////////////////// 은 조금만 사용하기!
• 주석으로 처리한 코드는 사용하지 않기!
• 주석 자체가 설명을 요구하지 않도록 이해하기 어려운 주석도 사용하지 않기!