Community

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

← Go back
Clean Code Day 6_4장. 주석
#clean_code
2년 전
655

오늘 TIL 3줄 요약

  • 좋은 주석은 주석을 달지 않을 방법을 찾아낸 주석이다.

  • 진실은 코드에만 존재하므로, 주석을 가능한 줄이도록 노력해야 한다.

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

TIL (Today I Learned) 날짜

2022.04.28

오늘 읽은 범위

4장, 주석

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

  • 일반적으로 대다수 주석을 허술한 코드를 지탱하거나, 엉성한 코드를 변명하거나, 미숙한 결정을 합리화하는 등 프로그래머가 주절거리는 독백에서 크게 벗어나지 못한다.

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

  • 코드를 작성하다보면 앞선 누군가가 적어놓은 주석을 보곤 나도 그 양식에 따라 생각없이 주석을 추가하곤 했다.(예를 들면 2022.04.28 ** 기능 추가 (누구의 요청인지..) 작성한나의 이니셜)


    하지만 이런 것들은 책에서도 기술되어있지만 정말 쓸모없는 주석이었다. 오늘도 이렇게 또 배움을 얻었다.

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

오늘 읽은 다른사람의 TIL