DAY09

  • 오늘 읽은 범위 : 주석 ~p94

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

  • 대다수의 주석이 나쁜주석의 범주에 속한다
    • 허술한 코드를 지탱하거나, 엉성한 코드를 변명하거나, 미숙한 결정을 합리화 한다.
  • 오해할 여지가 있는-살짝 잘못된 정보의- 주석은 동료개발자로 하여금 해당 주석만 믿고 함수를 호출하는 경우가 생길 수도 있기에 의도가 좋다 하더라도 주석은 조심스럽게 달아야 한다
  • 소스코드관리 시스템이 생긴 현 시점에서 이력을 관리하는 주석은 완전히 제거하는 편이 좋다. -이전 직장에서 누가 어떤 코드를 어디서 제거했는지까지 기록하는 경우가 있었는데 소스코드를 보기위해 너무나도 많은 스크롤을 내려야 하는 경우가 생기게 됐고 별로 보기도 좋지 않았다. 결과적으로 이력은 이력이기에 다시 돌아가서 확인하는 경우가 별로 발생하지 않았던 터라 해당 주석들은 있으나마나 한 부분이었다.
  • 먼저 주석으로 설명하고 그 주석에 맞춰 코드를 짜기보다는 주석이 필요하지 않도록 코드를 개선하는 편이 좋다.
  • 때때로 우리는 너무 많은 중첩블록으로 인하여 닫는 블록에 주석을 다는 경우가 생긴다. 하지만 클린코드에서 지향하는 작고 캡슐화된 함수에는 닫는 블록에 주석을 달아야겠다 생각이 들면 함수를 줄이려 시도하는 편이 더 좋겠다.
  • 정말 많은 경우 개발자들은 주석으로 처리된 코드를 지우기를 꺼려한다. 만약 우리가 쓰지 않을 코드를 주석처리를 했다면 다음 사람을 위해서 해당 코드들을 지워주자.-우리의 소스코드관리시스템이 전부 기억해줄 것이다.-

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

  1. 개발자로써 함수에 담긴 모든 내용을 유지보수하기란 힘들기 때문에 주석을 다는 경우가 많이 생깁니다. 하지만 이 장을 읽고 나서 그 모든 생각들이 틀렸으며 함수를 장황하고 주절주절 설명하는 주석보다 그 길고 추상화되지 않은 함수들을 각자 맞는 추상화의 함수로 분리하고 제대로 설명하는 이름으로 정의하여 읽는사람으로 하여금 잘못된 정보를 줄 수 있는 주석보다 코드에 집중할 수 있도록 쓰는 것이 더 중요하다고 배웠습니다.
  2. 이 장에서 주석은 사용해야 할 근거가 없다면 사용하지 않는게 좋다라고 배웠습니다. 앞으로는 주석이 없어도 표현력이 풍부한 코드를 짜야겠다 생각했습니다

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

  • -

세줄 요약

  • 주석으로 주절거리지 말아라
  • 주석으로 잘못된 정보를 퍼뜨리지 마라
  • 백번 말로 설명하는 주석보다 이름으로 표현하는 함수가 낫다

주석