Community

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

← Go back
TIL - Chapter 4. 주석
#clean_code
2년 전
437


TIL (Today I Learned)

// 2022.02.25

오늘 읽은 범위

// 4장. 주석

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

  • 사실상 주석은 기껏해야 필요악이다.(p.68)

  • 진실은 한곳에만 존재한다. 바로 코드다.(p.69)

  • 코드에 주석을 추가하는 일반적인 이유는 코드 품질이 나쁘기 때문이다. 자신이 저지른 난장판을 주석으로 설명하려 애쓰는 대신에 그 난장판을 깨끗이 치우는 데 시간을 보내라! (p.69)

  • 자칫 대수롭지 않다고 여겨질 뭔가의 중요성을 강조하기 위해서도 주석을 사용한다. (p.75)

  • 주석으로 처리된 코드는 다른 사람들이 지우기를 주저한다. 이유가 있어 남겨놓았으리라고, 중요하니까 지우면 안 된다고 생각한다. 그래서 질 나쁜 와인병 바닥에 앙금이 쌓이듯 쓸모 없는 코드가 점차 쌓여간다. (p.86)

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

  • 읽는 내내 역시 뼈맞는 기분이었고 찔렸지만 기존 챕터들과 다르게 어느정도 의문도 동시에 들었던 챕터이기도 했다. 변수나 함수로 잘 표현하면 주석으로 설명할 필요 없다고 했지만 사실 이건 같은 영어권 사람들이나 그렇지 우리처럼 다른 언어를 사용하는 나라에서는 어느정도 주석이 도움이 되지 않나 싶다. 영어가 아주 능숙하고 익숙하지 않은 이상 영어로 아무리 잘 변수를 표현한들 한국인 입장에서는 한국어 주석에 더 눈이 먼저 가지 않을까 싶다.

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

  • 자바공부는 학교다닐 때 외에는 해본 적 없는데 다시 배워야겠다는 생각이 든다.