TIL (2022.01.28 ~ 2022.01.29)
DAY 8~9
🔖 오늘 읽은 범위 : 4장, 주석 (p.68 ~ p.94)
😃 책에서 기억하고 싶은 내용을 써보세요.
- 사실상 주석은 기껏해야 필요악이다. (p.68)
- 우리는 코드로 의도를 표현하지 못해, 그러니까 실패를 만회하기 위해 주석을 사용한다.
- 주석을 달 때마다 자신에게 표현력이 없다는 사실을 푸념해야 마땅하다.
- 주석이 코드에서 분리되어 점점 더 부정확한 고아로 변하는 사례가 너무도 흔하다.
- 자신이 저지른 난장판을 주석으로 설명하려 애쓰는 대신에 그 난장판을 깨끗이 치우는 데 시간을 보내라 (p.69)
- 좋은 주석 (p.70)
- 법적인 주석
- 정보를 제공하는 주석
- 의도를 설명하는 주석
- 의미를 명료하게 밝히는 주석
- 결과를 경고하는 주석
- TODO 주석
- 중요성을 강조하는 주석
- 공개 API에서 Javadocs
- 나쁜 주석 (p.75)
- 주절거리는 주석
- 같은 이야기를 중복하는 주석
- 오해할 여지가 있는 주석
- 의무적으로 다는 주석
- 이력을 기록하는 주석
- 있으나 마나 한 주석
- 무서운 잡음
- 함수나 변수로 표현할 수 있다면 주석을 달지 마라
- 위치를 표시하는 주석
- 닫는 괄호에 다는 주석
- 공로를 돌리거나 저자를 표시하는 주석
- 주석으로 처리한 코드
- HTML 주석
- 전역 정보
- 너무 많은 정보
- 모호한 관계
- 함수 헤더
- 비공개 코드에서 Javadocs
🤔 오늘 읽은 소감은? 떠오르는 생각을 가볍게 적어보세요
- 주석으로 처리한 코드를 너무 싫어한다. 코드에 주석으로 처리된 코드가 범벅이면 작성자의 의도를 파악하기가 힘들고 위에서부터 아래로 읽는 흐름에 방해가 된다. 시간을 빼앗기는 것은 물론이고 잘못된 정보를 얻을 수도 있다.
- 우리에겐 git이 있잖아!
- 톰캣, 아파치 같은 곳에서도 실수하다니!? 신기했다.
- “주석을 달 때마다 자신에게 표현력이 없다는 사실을 푸념해야 마땅하다” 뼈 맞은 것 같다. 아프다!
기록하신 TIL을 공유해주세요 - TIL 출석표
소감 3줄 요약
- 주석은 필요악
- 꼭 필요할 때만 주석을 달자. 대부분은 2~3장의 규칙만 잘 지켜도 주석을 달 일이 없다.
- 코드로 표현할 것. 불필요한 주석은 혼돈을 준다.
얍얍 개발 펀치