Community

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

← Go back
TIL 주석
#clean_code
2년 전
483


TIL (Today I Learned)

// 2022.02.25

오늘 읽은 범위

// 4장 주석

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

  • 주석은 나쁜 코드를 보완하지 못한다.

    표현력이 풍부하고 깔끔하며 주석이 거의 없는 코드가 복잡하고 어수선하며 주석이 많이 달린 코드보다 훨씬 좋다.69p

  • 코드로 의도를 표현하라

    많은경우 주석으로 달려는 설명을 함수로 만들어 표현해도 충분하다. 70p

  • 좋은주석 70p

    법적인 주석

    정보를 제공하는 주석

    -> 때로는 기본적인 정보를 주석으로 제공하면 편리하다

    의미를 명료하게 밝히는 주석

    -

    >

    표준라이브러리 등 변경하지 못하는 코드의 경우 의미를 명료하게 밝히는 주석이 유용할 수 있음

    결과를 경고하는 주석

    TODO 주석 -> 다만 주기적으로 점검해 없애라

  • 나쁜주석 75p

주절거리는 주석

같은이야기를 반복하는 주석

오해할 여지가 있는 주석

있으나 마나 한 주석

함수나 변수로 표현할 수 있다면 주석을 달지마라

위치를 표시하는 주석

닫는 괄호에 다는 주석

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

  • 4장 주석을 읽고나니 평소 내가 얼마나 필요없는 주석을 많이 달았는지 깨닫게 되었다. 함수의 의도가 명확하다면 주석이 필요없다라는 말에 머리를 한대 맞은 느낌이었다. 앞으로 명심해서 함수를 만들고 꼭 필요한 경우에만 주석을 달 수 있도록 해야겠다.