TIL (Today I Learned)

20220224

오늘 읽은 범위

4장. 주석

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

• 나쁜 코드에 주석을 달지 마라. 새로 짜라 P68

• 좋은 주석

  • 정보를 제공하는 주석
    - "때때로 위와 같은 주석이 유용하다 할지라도, 가능하다면, 함수 이름에 정보를 담는 편이 더 좋다." P71

  • 의도를 설명하는 주석

  • 의미를 명확하게 밝히는 주석
    - "때때로 모호한 인수나 반환값은 그 의미를 읽기 좋게 표현하면 이해하기 쉬워진다." P72

  • 결과를 경고하는 주석, TODO 주석, 중요성을 강조하는 주석

• 나쁜 주석

  • 주절 거리는 주석
    -"특별한 이유 없이 의무감으로 혹은 프로세스에서 하라고 하니까 마지못해 주석을 단다면 전적으로 시간낭비다. 주석을 달기로 결정했다면 충분한 시간을 들여 최고의 주석을 달도록 노력한다"P76

  • 의무 적으로 다는 주석
    -"모든 함수에 javadocs를 달거나 모든 변수에 주석을 달아야한다는 규칙은 어리석기 그지없다. 이런 주석은 코드를 복잡하게 만들며, 거짓말을 퍼뜨리고, 혼돵과 무질서를 초래한다."P80

  • 있으나 마나한 주석

  • 모호한 관계
    주석과 주석이 설명하는 코드는 둘 사이 관계가 명백해야 한다. - 89p

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

• 나는 주석 신봉자다. 회사에서 내가 작성한 코드를 보고 이해하지 못했던 경험이 있었다.
  그 경험이 있고나서부터 주석을 적는게 정답으로 생각했고 주석을 미친듯이 적기 시작했다. 지금도 그러고 있다. 주석을 적기 위해서는 한줄 한줄이 의미가 있어야했다.

• 하지만 클린 코드를 보고 주석이 주는 위험성에 대해서 알수 있었다. 주석이 정답이라 생각하고 적었던 내 소스에는 있으나 마나한 주석들이 즐비하게 있었다. 나혼자서만 주절거리고 있었던 거였다.

• 클린 코드를 통해 주석의 위험성을 알수 있었다. 즉 주석도 지속적으로 관리가 되어야한다는 것이다. 그러기위해서는 2배로 관심과 작업을 드려야한다..막상 그래야한다니 그럴 자신이없다.

• 이번 주석 파트를 통해 더좋은 주석과, 좋지 않는 주석을 분간할수 있는 기준이 생긴거 같다.
  좋지 못한 주석들이 있으면 어서가서 지워야겠다~

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

• 저자가 예제 소스를 리펙토링 했는데. 리펙토링된 함수명에 단어들의 의미를 몰라서 함수명을 이해하지 못했다

  • determine : 결정하다

  • Interation : 상호작용

  • crossout : 선을 그어 지우다

  • generate : 발생시키다