Community

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

← Go back
TIL - Assignment #06( ~ 4장. 주석)
#clean_code
2년 전
410


TIL (Today I Learned)

2022.02.24(목) ~ 2022.02.25(금)

오늘 읽은 범위

~ 4장. 주석

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

  • 주석은 ‘순수하게 선하지’못하다. ….우리는 코드를 의도로 표현하지 못해, 그러니까 실패를 만회하기 위해 주석을 사용한다.(68p)

  • 주석을 달 때마다 자신에게 표현력이 없다는 사실을 푸념해야 마땅하다.(68p)

  • 부정확한 주석은 아예 없는 주석보다 훨씬 더 나쁘다.(69p)

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

  • 몇 초만 더 생각하면 코드로 대다수 의도를 표현할 수 있다.(70p)

  • 모든 함수에 Javadocs를 달거나 모든 변수에 주석을 달아야 한다는 규칙은 어리석기 그지없다.(80p)

  • …주석이 올바른지 검증하기 쉽지 않다. 이것이 의미를 명료히 밝히는 주석이 필요한 이유인 동시에 주석이 위험한 이유이기도 하다.(73p)

  • 있으나 마나 한 주석을 달려는 유혹에서 벗어나 코드를 정리하라. 더 낫고, 행복한 프로그래머가 되는 지름길이다.(83p)

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

  • 개인적으로도 주석다는걸 별로 안좋아하는 편이라, 주석을 볼 때 마다 지우려고 노력한다. 하지만, 모든 사람이 코드를 잘 짜는건 아니기 때문에 항상 주석을 지우고 싶은 마음과 그대로 놔두고 싶은 마음이 충돌한다.

  • 저자는 몇 초만 더 생각하면 코드로 대다수 의도를 표현할 수 있다고 하는데, 이는 영어권 독자들을 염두해 두고 하는 말인 것 같다. 한국인은 특히 영어 '읽기'에 스탯이 몰빵되어 있기 때문에, 제대로 된 함수명을 짓기에는 너무나 많은 시간이 필요하다. 대부분 코드의 품질이 좋지 않은 이유는 시간이 쫓기기 때문이고, 시간에 쫓기지 않는 개발자는 거의 없다고 생각하기 때문에 자연스럽게 코드가 조금씩 엉망이 되어 간다. '깨진 유리창 이론'을 생각해보면 이는 너무나 당연하다. 초기에는 정말 좋은 품질의 코드여도, 시간이 지나면서 코드에 균열이 생기게 되고 결국에는 일은 많은데 시간이 없는 경우가 대다수이다 보니 코드는 점점 엉망이 되어간다.

  • 특히, 함수를 작성할때 꼭 docs를 작성하는 편이데 이 조차도 좋지 않은 습관이 될 수 있다는 것을 알게 되었다. 코드로 모든걸 표현할 수 있는 경지에 이르면 얼마나 좋을까!

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

  • 스레드에 안전하지 못하다? 라는 의미가 모호하

  • 77p의 목록 4-1의 코드가 잘 이해되지 않는다

  • XP 몰입: XP 프로그래밍을 말하는건가?