Community

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

← Go back
TIL.006 클린코드 주석
#clean_code
2년 전
625


TIL (Today I Learned)

2022.02.24-02.25.

오늘 읽은 범위

4장. 주석

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

  • 부정확한 주석은 아예 없는 주석보다 훨씬 더 나쁘다. 부정확한 주석은 독자를 현혹하고 오도한다. (p.69)

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

  • 주석을 달기로 결정했다면 충분한 시간을 들여 최고의 주석을 달도록 노력한다. (p.76)

  • 함수나 변수로 표현할 수 있다면 주석을 달지 마라 (p.84)

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

  • 이제는 주석으로 처리할 필요가 없다. 그냥 코드를 삭제하라. 잃어버릴 염려는 없다. 약속한다.(p.87)

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

  • 여전히 코드를 이해하기는 어렵다. 다만 저자가 말하려는 바는 충분히 와닿고 있다.

  • 그동안 코딩 공부를 하면서 니코쌤이 만들었다가 변경하는 코드는 주석으로 처리하면서 기록해왔다. 공부 할 때는 괜찮지만 실제로 개발할 때는 최대한 줄여야겠다.

  • 어쨌든 코드로써 개발자가 말하고자 하는바를 충분히 말하고 그 연장선에서 코드로 표현 할 수 없는 부분을 주석으로 표현하자

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

  • 여전히 모르는 JAVA코드를 제외하고는 이번 챕터에서 딱히 궁금 한 것은 없었다.