[Clean Code] 📂. Assignment #06. 4장. 주석

TIL (Today I Learned)

2022.02.24(목) ~ 2022.02.25(금)

오늘 읽은 범위

• 4장. 주석 (p.94)

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

주석은 오래될수록 코드에서 멀어진다.
주석은 언제나 코드를 따라가지 않는다.
따라서, 주석을 가능한 줄이도록 노력해야한다.

1. 좋은 주석
   • 법적인 주석 : 법적인 이유로 추가하는 특정 주석
     • ex) 저작권 정보, 소유권 정보 등
   • 정보를 제공하는 주석
   • 의도를 설명하는 주석 : 결정에 깔린 의도까지 설명
   • 의미를 명료하게 밝히는 주소
   • 결과를 경고하는 주석
   • TODO 주석 : 앞으로 할 일 표시
   • 중요성을 강조하는 주석
   • 공개 API에서 Javadocs

1. 나쁜 주석
   • 주절거리는 주석
   • 같은 이야기를 중복하는 주석
   • 오해할 여지가 있는 주석
   • 의무적으로 다는 주석
   • 이력을 기록하는 주석
   • 있으나 마나 한 주석
   • 무서운 잡음
   • 함수나 변수로 표현 가능한 주석
   • 위치를 표시하는 주석
   • 닫는 괄호에 다는 주석
   • 공로를 돌리거나 저자를 표시하는 주석
   • 주석으로 처리한 코드
   • HTML 주석
   • 전역 정보
   • 너무 많은 정보
   • 모호한 관계
   • 함수 헤더
   • 비공개 코드에서 javadocs

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

지금까지 내가 아닌 다른사람이 코드를 볼 때 이해하는데 도움이 될 것같은 정보를 위주로 주석을 달았었다. ‘4장. 주석’을 읽으면서 좋은 코드와 나쁜 코드 부분을 읽는데 내가 배려하는 것이라 생각 하는 부분이 나쁜 주석 분류에 들어가는 것을보고 고쳐야겠다는 생각을 했다.

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

없음

---