오늘 TIL 3줄 요약

• 잘 달린 주석은 그 어떤 정보보다 유용하다.

• 정말로 좋은 주석은, 주석을 달지않을 방법을 찾아낸 주석이라는 사실을!

• 주석으로 처리한 코드만큼 밉살스러운 관행도 드물다.

TIL (Today I Learned) 날짜

2022..04.30

오늘 읽은 범위

4장. 주석

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

• 잘 달린 주석은 그 어떤 정보보다 유용하다. (p.68)

• 나라면 코드를 깔끔하게 정리하고 표현력을 강화하는 방향으로, 그래서 애초에 주석이 필요 없는 방향으로 에너지를 쏟겠다. (p.69)

• 코드에 주석을 추가하는 일반적인 이유는 코드 품질이 나쁘기 때문이다. (p.69)

• 표현력이 풍부하고 깔끔하며 주석이 거의 없는 코드가, 복잡하고 어수선하며

  주석이 많이 달린 코드보다 훨씬 좋다. (p.69)

• 자신이 저지른 난장판을 주석으로 설명하려 애쓰는 대신에 그 난장판을 깨끗이 치우는 데 시간을 보내라!(p.69)

• 많은 경우 주석으로달려는 설명을 함수로 만들어 표현해도 충분하다. (p.70)

• 정말로 좋은 주석은, 주석을 달지않을 방법을 찾아낸 주석이라는 사실을! (p.70)

• TODO 주석은 프로그래머가 필요하다 여기지만 당장 구현하기 어려운 업무를기술한다. (p.74)

• 대다수 주석은 허술한 코드를 지탱하거나, 엉성한 코드를 변명하거나, 미숙한 결정을 합리화하는 등 프로그래머가 주절거리는 독백에서 크게 벗어나지 못한다. (p.75)

• 모든 함수에 Javadocs를 달거나 모든 변수에 주석을 달아야 한다는 규칙은 어리석기 그지없다. 이런 주석은 코드를 복잡하게 만들며, 거짓말을 퍼뜨리고, 혼동과 무질서를 초래한다. (p.80)

• 주석으로 처리한 코드만큼 밉살스러운 관행도 드물다. 다음과 같은 코드는 작성하지 마라! (p.86)

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

주석 챕터를 읽기 전에는 주석에 대해 어떻게 잘 쓸수 있는지에 대해 배울 것으로 기대했다. 특히 주석이 유용하게 쓰일 것이라는 나의 예상은 보기 좋게 빗나갔다. 주석의 사용에 대해 생각하게 되었다. 즉, 클린 코드가 되면 주석도 최소화된다는게 포인트인거 같다. 하지만 다른 사람이 주석을 읽거나 본인이 나중에 읽게 될 경우 주석을 기억하기 좋은 방법으로는 사용되지 않는지? 궁금증이 생겼다. 또한 한가지 방식이 아닌 여러가지 방식으로 코드를 짤경우에 코드를 주석으로 하는 경우가 종종있는데 다시한번 이 방식에 대해 생각해봐야하겠다.

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

오늘 읽은 다른사람의 TIL