TIL (Today I Learned)

2022.02.25

오늘 읽은 범위

4장 주석

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

• 소스 코드 관리 시스템은 누가 언제 무엇을 추가했는지 귀신처럼 기억한다. 저자 이름으로 코드를 오염시킬 필요가 없다.

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

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

• 사실 주석은 아무 때나 그냥 쓰는 건지 알았다. 수도 코드를 적을 때나, 그저 진짜 코드가 아니기에 그저 막 적어도 된다고 생각했던 것 같다. 하지만 글을 읽다보니 주석에 대한 것도 섬세하게 잘 다뤄줘야할 필요성을 느꼈다.

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

• Javadocs