오늘 TIL 3줄 요약

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

• 코드로 의도를 표현하라

• 좋은 주석 vs 나쁜 주석

TIL (Today I Learned) 날짜

2022. 04.28

오늘 읽은 범위

4장. 주석

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

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

• 코드로 의도를 표현하라

• 좋은 주석이란

  법적인, 정보를 제공, 의도를 설명, 의미를 명료하게 밝히는, 결과를 경고, TODO, 중요성 강조

• 나쁜 주석은

  주절거리는, 같은 이야기를 중복, 오해할 여지가 있는, 의무적으로 다는, 이력을 기록하는,

  있느나 마나한, 함수나 변수로 표현할 수 있는, 위치를 표시하는, 닫는 괄호에 다는, 공로를 돌리거나 저자를 표시한 주석, 주석으로 처리한 코드, 전역정보, 너무 많은 정보, 모호한 관계, 함수 헤더,

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

• 코드를 작성할 때면 의례적으로 주석을 다는 경우가 많다. 함수헤더와 같이 의무적으로 달게하는 무의미한 주석부터 코드에 대한 설명이나 다음을 위해 주석을 다는 경우가 많았다. 주석이 도움이 되는 경우도 많았지만 한편으로 더 헷갈리거나 코드를 보는데 방해하는 경우 또한 많다. 함수를 하나의 의도로 작게 만들어야 하는 것처럼 코드로 의도를 표현하도록 신경써야겠다.