Community

개발자 99% 커뮤니티에서 수다 떨어요!

← Go back

TIL - 4장 주석

#clean_code
1년 전
426

오늘 TIL 3줄 요약

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

  • 주석이 오히려 악영향을 끼칠 수 있으니 나쁜 주석에 대해 생각해보자.


TIL (Today I Learned) 날짜

2024. 08. 30


오늘 읽은 범위

  • 4장. 주석


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

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

  • 주의를 주는 주석을 작성하자


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

  • 이번 주제는 주석으로 어떻게 보면 앞에서 본 내용들과 크게 연관되어있다. 주석은 코드의 동작에 영향을 주지않기 때문에 코드를 읽는 개발자에게 거짓된 정보를 전달할 수 있다. 그렇기에 꼭 필요한 주석이 아니면 굳이 필요하지않다. 오히려 악역향을 끼치는 것이다. 평소 주석을 정말 필요한 경우가 아니면 사용하지않는데 몇개는 되돌아보고 수정을 해야겠다.

  • 이번 내용은 조금 실망스러웠다. 다양한 예시를 포함하고 있어 좋았지만 나쁜 주석에 대한 부분을 설명할 때는 했던 이야기를 반복하는 느낌이었고 주절주절 길게 늘려 작성되어있다는 느낌을 받았다. 모든 내용을 간단 명료하게, 필요한 부분만 설명할 수는 없겠지만 이번 장에서는 설명하는 주제와 설명하는 방식이 일치해야하는 게 아닌가,, 생각이 들었다.

  • Q. "전 개발자가 주석을 남겨줬으면 좋았을텐데,,," 라고 느꼈던 상황?

    • 일반적이지 않은 해결책으로 코드를 작성했을 때 기획의 문제 또는 사용자의 특별한 요구사항이 원인인 경우가 많았다. 이는 코드에서 알 수 없고 그저 특이한 상황이 연출되어 의문만 남긴다. 이럴 때는 주석이 정말 절실하게 필요했다. 추가로 쉽게 생각하지 못하는 에러 상황에 대해 왜 이렇게 처리를 했는지에 대한 내용도 듣고싶을 때가 많다. 이는 커밋에서 꼭 작성해줬으면 좋겠다.


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


오늘 읽은 다른사람의 TIL

  • https://nomadcoders.co/community/thread/10170

    • 현재 자신의 상황을 돌아보고 TIL을 읽는 사람들에게 상황을 설명하고 아쉬운 부분이 무엇인지 작성하여 정말 자신이 무엇을 느꼈는지에 대해 잘 작성해주셨습니다.

    • 나는 아직 내가 작성했던 주석에 대해 생각만 해봤을 뿐 정확한 사례를 찾지않았다. 생각에서 행동으로 옮기고 그를 기록하는 습관을 가지는 것이 정말 멋있고 배울 점인 것 같다. 진짜 멋있다.

  • https://velog.io/@hjeong1200/TIL-annotations

    • 이번 범위에 대한 내용을 정말 간단하게 정리해주셨습니다. 단순히 소감만 중요한 건 아니고 결국에는 내용도 기억에 남아야 좋은 TIL이라고 생각합니다. 나중에 작성자 분께서 다시 TIL을 읽었을 때 책의 내용이 새록새록 떠오를만큼 잘 작성되었다고 생각합니다.

    • 내가 잘 알고있다고 생각하는 부분도 나중에 까먹을 수 있고 어쩌다 놓칠 수 있기 때문에 내용 정리는 조금 더 상세하게 작성해도 좋을 것 같다. 이번에는 작성자 분 내용을 훔쳐봐야겠다.

  • https://synonymous-currant-9b2.notion.site/3-f915821d62a546fe8d00f78f93694e6a

    • 자신의 생각이 달랐음을 인정하고 돌아보는 모습이 인상적이었습니다.

    • 요즘 회사에서 ChatGPT를 활용하는 개발자분들을 많이 볼 수 있는데 코드를 이해하지 못하고 그대로 붙여넣는 경우가 많았다. 궁금한 부분이 있어 여쭤보면 "ChatGPT가 이렇게,,," 와 같은 답변을 많이 들어 속상했는데 이렇게 깨닫는 분들이 있어 괜히 내가 기분이 좋아진다. 더 좋은 개발자가될 것 같다는 확신이 든다.