Community

개발자 99% 커뮤니티에서 수다 떨어요!

← Go back
TIL 4장. 주석
#clean_code
2년 전
598
2

2022.04.28

Today's Reading 4장. 주석

💡 오늘 TIL 3줄 요약

  • 가급적

  • 주석을

  • 달지마라!!!


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

  • 우리는 실패를 만회하기 위해 주석을 사용한다. 주석을 달 때마다 자신에게 표현력이 없다는 사실을 푸념해야 마땅하다. 😭

  • 좋은 주석

    1. 법적인 주석

    2. 정보를 제공하는 주석 - 주석이 없는 편이 낫긴함

    3. 의도를 설명하는 주석 - 결정에 깔린 의도 설명

    4. 결과를 경고하는 주석 - ex) 특정 테스트 케이스 꺼야 하는 이유를 설명하는 수적

    5. TO-DO 주석

엔진 후드를 열어볼 필요가 없다며 고객에게 아양 떠는 중고차 판매원과 비슷하다.(ㅋㅋㅋ)


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

  • 정말 웬만하면 주석을 쓰지 말라는 이야기인거 같다. 실패를 만회하기 위해 주석을 사용한다는 말이 심장에 박혔는데 대체로 나를 변명하거나 '혹시 제 의도를 이해 못하면 어떡하지?' 라는 마음으로 주석을 넣었던거 같다. 내 의도는 함수에 넣고 이 결정을 하게 된 이유가 서술이 불가피하면 적는 방식으로 고쳐야 겠다.

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

💬 오늘 읽은 다른사람의 TIL

2 comments