DAY 9

🔖 오늘 읽은 범위 : 5장 - 주석 (~p.94)

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

</aside>

• 나쁜 주석 (계속)

  • 함수나 변수로 표현할 수 있는 주석

    → 함수로 감싸거나 이름을 바꾸어 주석을 달 필요가 없게 한다.

  • 위치를 표시하는 주석

    → 특정 기능을 모아둔다면 유용할 수 있으나 남요하지 않는다.

  • 닫는 중괄호에 다는 주석

    → 중첩이 많은 함수에는 유용할 수 있으나 그냥 함수를 줄이는 것이 좋다.

  • 공로나 저자를 표시하는 주석

    → 소스 코드 관리 시스템을 이용해 표기한다. (READ_ME.md)

  • 주석으로 처리한 코드

    → 주석으로 표기한 이유를 알지 못해 지우기를 주저하게 된다. 소스 코드 관리 시스템을 활용한다.

  • HTML 주석

    → 주석을 더 읽기 어렵게 만든다. 기타 도구를 사용한다.

  • 위치가 잘못된 주석

    → 근처에 있는 코드에 관련해서만 주석을 단다.

  • 너무 많은 정보를 제공하는 주석

    → 흥미로운 역사나 관련 없는 정보는 주석에 늘어놓지 않는다.

  • 모호한 주석

    → 주석을 달거면 무엇이 무엇을 의미하는지 정확하게 작성한다.

  • 함수 헤더

    → 짧은 함수와 이름을 잘 붙인 함수가 훨씬 낫다.

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

</aside>

• 주석에 관련해 잘 모르는 내가 봐도 대놓고 잘못된 주석이 많은데 이 책에 소개될 정도면 얼마나 많은 사람들이 주석과 관련해서 많은 실수를 저지르고 있었던걸까? 특히 HTML 주석은 너무 경악스러웠다...😵 안 그래도 읽기 어려운 html 코드를 어떻게 주석에 쓸 생각을 한 걸까? 요즘은 마크다운 문서만 잘 작성해도 github에 올리면 알아서 깔끔하게 표시해주는데 말이다.
• 대부분의 주석들은 VCS만 잘 써도 필요 없어지는 것 같다. 그만큼 git과 같은 VCS를 잘 알아야 할 것 같다.
• 내가 편하자고 임시로 주석 처리한 코드는 나만 주석으로 처리한 이유를 안다. 임시로 주석을 다는 건 ‘나 혼자’ 개발할 때는 유용하지만 남에게는 그렇지 않다.
• 저자와 라이선스를 명시한 주석을 본 적이 있는데 여러 특수문자들을 이용해 멋지게 꾸며놓은 걸 보았을 때는 뭔가 그럴싸해 보였다. 지금 와서 생각해보니 정말 터무니 없었던 생각이었다...

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

</aside>

❌ 없음 ❌

기록하신 TIL을 공유해주세요 - TIL 출석표

클린코드_스케쥴러_TIL 출석표 (노개북1기)

소감 3줄 요약

• 주석을 대체할 수 있는 git을 좀 더 공부해야 할 것 같다.
• 임시로 주석으로 처리한 코드는 활용하고 난 후에는 삭제 하도록 한다.
• 역시나 코드를 짧게 만들고 이름을 잘 짓는 것이 중요하다.