오늘 TIL 3줄 요약

• 주석은 거짓말을 한다. 코드는 바뀌는데 주석은 안바뀐다.

• 가능하면 코드로 설명이 모두 되도록 한다

• 도움되는 주석이 있는 반면 나쁜 주석은 매우많다.

TIL (Today I Learned) 날짜

2022.04.29 새벽

오늘 읽은 범위

4장. 주석

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

도움되는 주석

• 법적인 주석

• 정보를 제공하는 주석

• 의도를 설명하는 주석 : 왜 그랬는지에 대한 의도를 설명

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

• 결과를 경고하는 주석 : 코드에 대한 경고

• TODO 주석, 앞으로 할일

• 중요성을 강조하는 주석

• javadocs, 웹은 jsdoc

나쁜 주석

• 주절거리는 주석

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

• 오해할 여지가 있는 주석

• 의무적으로 다는 주석

• 이력을 기록하는 주석 : 커밋기록으로 관리

• 있으나 마나 한 주석

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

• 닫는 괄호에 다는 주석

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

• HTML 주석 (ㅋㅋㅋ)

와 나쁜건 굉장히 많다

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

주석도 적당히 달자

가장 좋은건 주석 없이도 의미가 전달되는것이다.

오픈소스냐 아니냐에 따라서도 jsdoc를 꼭 써야하는지가 다르다는걸 알았다.

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

오늘 읽은 다른사람의 TIL