TIL (Today I Learned)

2022 02 26

오늘 읽은 범위

4장.주석

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

• 주석은 오래될수록 코드에서 멀어진다 -> 프로그래머들이 주석을 유지하고 보수하기에 현실적으로 힘들기에, 코드는 언제나 변화하고 진화하지만, 주석은 코드를 따라가지 못한다.

• 주석은 나쁜 코드를 보완하지 못한다. -> 코드에 주석을 추가하는 일반적인 이유는 코드 품질이 나쁘기 때문이다.

• 코드로 의도를 표현하라 ->코드로 의도를 표현할 수 있다.주석으로 달려는 설명을 함수로 설명해도 충분하다.

• 주석에서 너무 많은 정보를 담지 마라.

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

• 사실 나는 이 책을 읽기 전까지 주석은 프로그래밍에 영향을 끼치지 않기 때문에, 그렇게 큰 존재라고 생각하지 않았다. 음... 오히려 적으면 좋다고 생각했었다! 하지만 이 책을 읽고 나니까, 실무에서 정말 냅다 주석을 적었으면 혼났겠구나....라는 생각이 들었다. 주석을 달지 않고 설명이 되는 깔끔한 코드! 역시 코드를 잘 짜는 게 답이다!

• 4-7 코드를 설명하며 적은 문구에 "아래 모듈이 매력적인 이유는 우리들 상당수가 이런 코드를 보면서 '주석을 잘 달았다'라고 생각하던 시절이 있었기 때문이다. "라고 적혀있는데, 이것을 보며 웃음이 났다. 정말 사실 나는 팀 프로젝트에서 주석을 달며 내가 정리를 잘 해놓았구나 생각한 적이 있기 때문이다. 역시 아는 만큼만 보였던 거였다고 생각이 드는 순간이었다.

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