Community

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

← Go back
TIL 4장 주석 (22.02.26)
#clean_code
2년 전
470


TIL (Today I Learned)

2022.02.26

오늘 읽은 범위

4장. 주석

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

  • 진실은 한곳에만 존재한다. 바로 코드다.

  • 불행하게도 주석이 언제나 코드를 따라가지는 않는다.

  • 좋은 주석

    • 법적인 주석

    • 정보를 제공하는 주석

    • 의도를 설명하는 주석

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

    • 결과를 경고하는 주석

    • TODO 주석

    • 중요성을 강조하는 주석

  • 나쁜 주석

    • 주절거리는 주석

    • 같은이야기를 중복하는 주석

    • 오해할 여지가 있는 주석

    • 의무적으로 다는 주석

    • 이력을 기록하는 주석

    • 있으나 마나 한 주석

    • 위치를 표시하는 주석

    • 닫는 괄호에 다는 주석

    • 공로를 돌리거나 저자를 표시하는 주석

    • 주석으로 처리한 코드

    • HTML 주석

    • 전역 정보

    • 너무 많은 정보

    • 모호한 관계

    • 함수 헤더

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

  • 그동안 의미없는 주석을 많이 달았던 것 같다.

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