TIL (Today I Learned)

// 2022.02.24. ~ 2022.02.25.

오늘 읽은 범위

// 4장.주석

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

1. 나쁜 코드에 주석을 달지 마라.

   • 주석은 시간이 갈수록 틀린 정보만을 제공하여 오해를 일으킨다.

   • 주석을 지속적으로 보수 유지 하는것은 실질적으로 불가능하다.

   • 그 시간에 코드를 새로 고쳐써라.

   • 불행하게도 주석은 항상 코드를 따라가지는 않는다.

2. 좋은 주석

   • 저작권, 소유권 정보

   • 의도를 명료하게 밝히는 주석

   • 결과를 경고하는 주석

   • 중요성을 강조하는 주석

3. 나쁜 주석

   • 대다수 의 주석

   • 같은 이야기를 반족하는 주석

   • 위치를 표시하는 주석

   • 너무 많은 정보

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

• 나는 평소에 주석을 그렇게 많이 사용하는 편은 아니다. 동료들과 코드를 공유할때 함수나 변수의 수가 많은 경우 시각적으로 편의성을 위해 사용하거나 비교적 오랫동안 다시 볼일이 없을 것 같은 코드에 현재의 의도를 적어두곤 했다. 그러나 이번 장을 읽어보니 꾀나 회의감이 들었다. 생각해보면 언제봐도 이해하기 쉬운 코드를 작성할 수 있었더라면 위의 주석을 작성할 필요도 없었던 것이다. 이번장은 머리로는 이해가 갔지만 막상 다시 코드를 적으라고하면 바로 바뀌지는 못할것 같아 계속해서 의식하고 다시 읽어볼 필요가 있다고 느꼇다.