노개북 클린코드 #05

TIL (Today I Learned) 날짜

2024년 05월 08일 수요일

 

오늘 읽은 범위

4장. 주석

 

책에서 기억하고 싶은 내용

4장. 주석

1. 1. 가장 좋은 것은 코드만으로 의도를 모두 표현하는 것
   2. 좋은 주석
      1. 법적인 주석: 법적인 이유로 특정 주석을 넣어야 하는 경우
      2. 정보를 제공하는 주석
      3. 의도를 설명하는 주석: 구현의 이해를 넘어 결정의 의도까지 설명하는 경우
      4. 의미를 명료하게 밝히는 주석: 인수나 반환값이 표준 라이브러리 혹은 변경하지 못하는 코드에 속해있는 경우
      5. 결과를 경고하는 주석
      6. TO DO 주석 : 필요하다고 여기지나 당장 구현하기 어려운 업무가 존재하는 경우
      7. 중요성을 강조하는 주석
   3. 나쁜 주석
      1. 주절거리는 주석
      2. 같은 이야기를 중복하는 주석
      3. 오해할 여지가 있는 주석
      4. 의무적으로 다는 주석
      5. 이력을 기록하는 주석
      6. 있으나 마나 한 주석
      7. 무서운 잡음
      8. 함수나 변수로 표현 가능한 주석
      9. 위치를 표시하는 주석
      10. 닫는 괄호에 다는 주석
      11. 공로를 돌리거나 저자를 표시하는 주석
      12. 주석으로 처리한 코드
      13. HTML 주석
      14. 전역 정보 : 근처에 있는 코드의 주석만 기술
      15. 너무 많은 정보
      16. 모호한 관계 : 주석과 주석을 설명하는 코드는 둘 사이 관계가 명백해야 한다.
      17. 함수 헤더 : 짧은 함수는 긴 설명이 필요 없다.

 

나의 최애 북틸

https://nomadcoders.co/community/thread/9806 : 

https://velog.io/@wanderer94/Clean-Code-3%EC%9E%A5-%ED%95%A8%EC%88%98

https://bouncy-sloop-cbe.notion.site/Clean-Code-TIL-a39aa3c4246449e3b0b834c379d5a7f7

 

읽은 소감 + 떠오르는 생각

오늘 읽은 부분 중 가장 신기했던 부분이 TODO 주석이었다.

평소 README 파일에 앞으로의 TODO를 적는 편이었는데, TODO 주석을 달고 커밋하면 알아보기 편할 것 같다.

 

궁금한 내용 + 이해되지 않는 내용

오늘은 주석에 관한 내용이었는지 이해되지 않는 내용은 없었다.

책을 읽을수록 자바 코드를 더 능숙하게 읽고 싶다.