Community

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

← Go back
TIL 4장. 주석
#clean_code
2년 전
450


TIL (Today I Learned)

2022.02.24

오늘 읽은 범위

4장. 주석

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

  • 우리는 코드로 의도를 표현하지 못해, 그러니까 실패를 만회하기 위해 주석을 사용한다. 여기서 내가 실패라는 단어를 썼다는 사실에 주목한다. 진심이다. 주석은 언제나 실패를 의미한다. 때때로 주석 없이는 자신을 표현할 방법을 찾지 못해 할 수 없이 주석을 사용한다. 그래서 주석은 반겨 맞을 손님이 아니다. (p.68)

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

  • 뒤통수를 강하게 맞은 느낌. 나는 주석을 잘 작성해야 하는 것 또한 프로그래머의 덕목이라고 생각했다. 여기서 내가 말하는 잘 작성이라는 말의 의미는 '서술하듯 풀어서, 주석을 보고 이해할 수 있게' 다.

  • 4장을 읽으면 읽어나갈 수록 내가 코드로 표현하는 방법을 몰라, 아니 표현하는 방법을 알았다고 하더라도 이를 잘 녹여냈을까? 하는 의구심도 있지만 이런저런 이유로 인해서 주석이 많았었나 싶기도 하고 한편으로는 주석은 없지만 제대로 표현하지 못한 점이 많았다.

  • 내가 다시 돌아와서 코드를 보았을 때 '왜 이렇게 작성해두었을까?', '

    의도가 뭐지?' 등의 다양한 질문이 생길 수 밖에 없었던 이유를 알게 되었다.

  • 주석을 줄여보려고 한다. 단, 주석을 줄일 수 있을 만큼 코드 내에 잘 녹여낼 수 있도록 더 많은 고민도 함께 할 것이다. 나아진 나의 코드를 보고 내가 웃을 일이 생겼으면 좋겠다.

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

  • 목록 4-1에 나오는 주석이 어째서 오해의 여지가 있는지 알겠는가? this.closed가 true로 변하는 순간에 메서드는 반환되지 않는다. this.closed가 true여야 메서드는 반환된다. 아니면 무조건 타임아웃을 기다렸다 this.closed가 그래도 true가 아니면 예외를 던진다 -> 이 부분이 이해가 잘 되지 않습니다. (p.79)

    • 추가로 목록 4-1(p.77) 예시 내 public synchronized (자바를 공부안해서 모르는 거 같습니다.. ㅜ)