오늘 TIL 3줄 요약
- 함수나 변수로 표현할 수 있다면 주석을 달지 마라
- 나쁜 주석
- ToDo 주석
</예시>
TIL (Today I Learned) 날짜
2022. 04.28
오늘 읽은 범위
4장 주석
책에서 기억하고 싶은 내용을 써보세요.
- 나쁜 주석 : 대다수 주석이 이 범주에 속한다. 일반저긍로 대다수 주석은 허술한 코드를 지탱하거나, 엉성한 코드를 변명하거나, 미숙한 결정을 합리화하는 등 프로그래머가 주절거리는 독백에서 크게 벗어나지 못한다.
- 있으나 마나 한 주석 : 때때로 있으나 마나 한 주석을 접한다. 쉽게 말해, 너무 당연한 사실을 언급하며 새로운 정보를 제공하지 못하는 주석이다.
- 의무적으로 다는 주석 : 모든 함수에 javadocs를 달거나 모든 변수에 주석을 달아야 한다는 규칙은 어리석기 그지없다. 이런 주석은 코들르 복잡하게 만들며, 거짓마을 퍼뜨리고 혼동과 무질서를 초래한다.
- 함수나 변수로 표현할 수 있다면 주석을 달지마라.
오늘 읽은 소감은? 떠오르는 생각을 가볍게 적어보세요
- 어지간하면 주석을 달지 말자. 단 어떠한 방법으로도 코드로 표현이 되지 않는 경우에만 조금씩 사용하자.
궁금한 내용이 있거나, 잘 이해되지 않는 내용이 있다면 적어보세요.
- 특별히 없다.
오늘 읽은 다른사람의 TIL
'IT > Clean Code 도전' 카테고리의 다른 글
| 6장 객체와 자료구조 (0) | 2022.05.03 |
|---|---|
| 5장 형식 맞추기 (0) | 2022.05.02 |
| 3장 함수 (0) | 2022.04.27 |
| Mission: 나의 최애 북틸 (0) | 2022.04.25 |
| 2장 의미있는 이름 (0) | 2022.04.24 |