Community

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

← Go back
Assignment # 6
#clean_code
2년 전
467

오늘 TIL 3줄 요약

  • 잘 달린 주석은 그 어떤 정보보다 유용하다.

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

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

TIL (Today I Learned) 날짜

2022.04.28~2022.04.29

오늘 읽은 범위

4장. 주석

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

  • 법적인 주석 - 때로는 회사가 정립한 구현 표준에 맞춰 법적인 이유로 특정 주석을 넣으라고 명시한다.

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

  • 의도를 설명하는 주석 - 때로는 주석은 구현을 이해하게 도와주는 선을 넘어 결정에 깔린 의도까지 설명한다.

  • 의미를 명료하게 밝히는 주석 - 때때로 모호한 인수와 반환값은 그 의미를 읽기 좋게 표현하면 이해하기 쉬워진다.

  • 결과를 경고하는 주석 - 때로 다른 프로그래머에게 결과를 경고할 목적으로 주석을 사용한다.

  • TODO 주석 - 때로는 앞으로 할일을 // TODO 주석으로 남겨두면 편하다.

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

  • 올바른 주석을 남겨야겠다.

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

오늘 읽은 다른사람의 TIL