[ 클린코드 매일 읽기 ] TIL 4장. 주석

원장·2024년 1월 31일
nomadcoder개발자북클럽노개북노마드코더
0

클린코드

목록 보기
5/10
post-custom-banner

3줄 요약

  • 주석을 쓰되 이상하게 쓰지 말아야한다. 조금만 이상하게 써도 주석에 대한 신용이 떨어진다.
  • 주석에 이상한 짓을 하는 케이스를 많이 보여주셔서 신기했다. 그런 잘못된 방법 시작도 하지 말아야지.
  • 코드를 백업용도로 주석처리하는거,return true 함수면 true를 리턴한다고 주석을 쓴다던가 하는 내용이 와닿은게 옛날도 그렇고 지금도 그렇고 내 습관이여서 바꿔야할 것 같다...

오늘 읽은 범위

4장 주석

책에서 기억하고싶은 내용

  • 나쁜 코드에 주석을 달지 마라. 새로 짜라. [68]
  • 몇 초만 더 생각하면 코드로 대다수 의도를 표현할 수 있다 [70]
  • 엔진 후드를 열어볼 필요가 없다며 고객에게 아양 떠는 중고차 판매원과 비슷하다 [77]
  • 목록 4-2 ContainerBase.java(톰캣) [77~79]
  • 위와 같은 주석은 지나친 참견이라 개발자가 주석을 무시하는 습관에 빠진다. 코드를 읽으며 자동으로 주석을 건너뛴다. [82]
  • 주석으로 처리된 코드는 다른 사람들이 지우기를 주저한다. 이유가 있어 남겨놓았으리라고, 중요하니까 지우면 안된다고 생각한다. 그래서 질 나쁜 와인병 바닥에 앙금이 쌓이듯 쓸모 없는 코드가 점차 쌓여간다.

읽은 소감과 떠오르는 생각

  • 시작하자마자 68~69p에서 주석을 쓰지말라는 내용을 완고하게 말한다. 근데 나는 주석은 필요하다고 생각한다. 왜냐하면 오늘 퇴사를 했는데 어제까지 인수인계를 했다. 만약 인수인계 과정에서 설명을 듣는 사람이 코드만 보고 이해할 정도로 뛰어난 개발자라면, 나는 따로 주석을 달지 않았을 것 같다. 하지만 코드를 보는 사람이 코드 조차 읽지 못하는 수준이었다. 상식적으로는 내부에 코드만 보고 이해할 수 있는 개발자가 있어야하는 것이 맞지만 그러지 않는 회사도 많기 때문에 쓸 수 있다고 생각한다. 하지만 주석을 쓸 때도 저자가 우려하는 거짓말을 할 수 있다는 부분과 나쁜 코드여서 주석을 쓰는건 지는 생각해봐야겠다.
  • 주석대신 함수명으로 의도를 표현한 것을 보고 코딩하는 사람들의 주언어가 영어라면 정말 필요하지 않을 수도 있는건가 싶다.
  • 읽다보니 주석을 쓰는건 거의 99% 반대하지만 써야할 경우라면 어떻게 써야하는 지 알려주네..
  • //TODO 주석 보기만 하고 사용해보진 않았는데 저자가 권장하는거 봐서 써봐야겠다고 느낌.
  • 주석이 중고차 판매하는데 구매하는 사람들을 눈을 가리는 역할을 할 수도 있겠구나 느꼈다... 직접 보는게 맞다....
  • 목록 4-2 ContainerBase.java 코드 주석보니 파국이다; 이런식으로 주석 쓸거면 쓰지 말아야겠다고 생각했다.
  • 주석을 95% 잘 썼더라도 5%가 이상한 주석이라면 개발자가 주석을 무시할 수도 있겠구나 느꼈다... 주석 쓸거면 제대로 써야하겠다..
  • 코드를 치면서 백업용도라 생각하고 주석처리하고 코드를 남겨둘 때가 있었는데 어차피 git에도 남고 지우는게 맞다... 앞으로는 코드에 그러지 말자 ㅠㅠ
  • 89페이지처럼 진짜 역사를 쓰는 사람이 있다고..?
  • 90페이지 에라토스테네스 설명한거 킹받네..
  • 알고리즘 설명할 경우에는 그냥 무슨 알고리즘을 썼는지만 써도 될듯하다...

궁금한 내용이나 잘 이해되지 않는 내용

  • 츤데레처럼 주석 쓰는거 잘 설명해줄거면서 왜 주석 아예 쓰지말라고 처음에 강하게 말했는지..

최애 북틸과 선정 이유

profile
원장
나 원장이 아니다
이전 포스트

[ 클린코드 매일 읽기 ] TIL 3장. 함수

다음 포스트

[ 클린코드 매일 읽기 ] TIL 5장. 형식 맞추기

post-custom-banner

0개의 댓글