오늘 TIL 3줄 요약
- 주석은 나쁜 코드를 보완하지 못한다.
- 코드로 의도를 표현하라 !
- 정말로 좋은 주석은, 주석을 달지 않을 방법을 찾아낸 주석이라는 사실
TIL (Today I Learned) 날짜
2022.04.28 ~
2022.04.29
오늘 읽은 범위
4장. 주석
책에서 기억하고 싶은 내용을 써보세요.
- 우리는 코드로 의도를 표현하지 못해, 그러니까 실패를 만회하기 위해 주석을 사용한다. 여기서 내가 실패라는 단어를 썼다는 사실에 주목한다. 진심이다. 주석은 언제나 실패를 의미한다. 때때로 주석 없이는 자신을 표현할 방법을 찾지 못해 할 수 없이 주석을 사용한다. 그래서 주석은 반겨 맞을 손님이 아니다.
오늘 읽은 소감은? 떠오르는 생각을 가볍게 적어보세요
책의 작가는 주석을 부정적으로 바라보고 있다. 실패를 만회하기 위한 수단으로 말이다. 하지만 한국과 같은 영어를 주 언어로 사용하지 않는 국가에서는 예외라고 생각한다. 클래스, 메소드, 변수를 영어로 정의하지만 이를 즉각적으로 이해하기란 어렵다. 우리는 한국어가 익숙하기 때문에 한국어로 설명이 부가적으로 있어야 눈에 잘들어온다. (물론 나의 영어 실력이 아직 부족해서 일 수도 있다.🥲)
나는 오픈소스로 프로젝트를 Git Hub에 올려놨는데 주석을 안달아놨다. 완벽한 주석을 달고 싶다는 생각과 혼자 만드는 프로젝트이기 때문에 설명이 필요하지 않다고 생각했기 때문이다. 하지만 생각해보니 나중에 포트폴리오로 사용하거나 다른 사람이 내 코드를 볼 수도 있기 때문에 주석은 당연한 것이었다. 평소에 다른 사람의 코드를 보면서 '여기엔 주석이 없어서 이해하기 쉽지 않네'라고 생각했었는데 내로남불이었다. 지금이라도 내 코드들에 주석을 달아야겠다.
책에서 추천하는 좋은 주석 중에 하나인 TODO 주석은 써볼만한 좋은 주석이다. 앞으로 할 일을 TODO 주석으로 남겨두면 잊어버릴 염려가 없을 것이다.
