오늘 TIL 3줄 요약

• 주석은 최대한 안적는게 좋다.

• 주석을 달기보다는 코드를 깔끔하고 명확하게 고쳐라.

• 대부분의 주석은 함수명으로 표현이 가능하다.

TIL (Today I Learned) 날짜

2022. 04. 29

오늘 읽은 범위

4장. 주석

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

• 코드는 변화하고 진화한다. 불행히도 주석이 언제나 코드를 따라가지는 못한다.

• 주석을 달기보다는 코드를 깔끔하게 고쳐라.

  
  ex) 주석으로 달려는 설명을 함수로 만들어 표현해도 충분하다.

• 좋은 주석

  1. 법적인 주석

  2. 정보를 제공하는 주석

  3. 의도를 설명하는 주석

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

  5. 결과를 경고하는 주석

  6. TODO(필요하다 여기지만 당장 구현하기 어려운 업무) 주석

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

• 나쁜 주석

  1. 주절거리는 주석

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

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

  4. 의무적으로 다는 주석

  5. 이력을 기록하는 주석

  6. 있으나 마나 한 주석

  7. 무서운 잡음

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

  9. 위치를 표시하는 주석

  10. 닫는 괄호에 다는 주석

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

  12. 주석으로 처리한 코드

  13. HTML 주석

  14. 전역 정보

  15. 너무 많은 정보

  16. 모호한 관계

  17. 함수 헤더

  18. 비공개 코드에서 Javadocs

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

• 위의 나쁜 예시 한번씩 다 해본거 같은데?

• 주석을 쓸 때마다 이렇게 까지는 아니지 않나 싶더라니...

• 주석을 쓰고 싶을 때 마다 코드 먼저 다시 한번 뜯어봐야겠다.