TIL (Today I Learned)

22.02.25.

오늘 읽은 범위

4장. 주석

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

• 나쁜 코드에 주석을 달지 마라. 새로 짜라. (p.68)

• 우리는 코드로 의도를 표현하지 못해, 그러니까 실패를 만회하기 위해 주석을 사용한다. (p.68)

• 표현력이 풍부하고 깔끔하며 주석이 거의 없는 코드가, 복잡하고 어수선하며 주석이 많이 달린 코드보다 훨씬 좋다. (p.69)

• 좋은 주석 (p.70~75)

  1. 법적인 주석

  2. 정보를 제공하는 주석

  3. 의도를 설명하는 주석

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

  5. 결과를 경고하는 주석

  6. TODO 주석

  7. 중요성을 강조하는 주석

• 나쁜 주석(p.75~90)

1. 주절거리는 주석

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

3. 오해할 여지가 있는 주석

4. 의무적으로 다는 주석

5. 이력을 기록하는 주석

6. 있으나 마나 한 주석

7. 무서운 잡음

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

9. 위치를 표시하는 주석

10. 닫는 괄호에 다는 주석

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

12. 주석으로 처리한 코드

13. HTML 주석

14. 전역 정보

15. 너무 많은 정보

16. 모호한 관계

17. 함수 헤더

18. 비공개 코드에서 Javadocs

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

• 주석은 많이 달수록 좋다고 알고 있던 상식을 깨는 챕터였다. 생각 없이 적었던 주석들을 반성한다.

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