오늘 TIL 3줄 요약

• 나쁜 코드에 주석을 달지마라, 새로 짜라

• 코드만이 정확한 정보를 제공하는 유일한 출처다. 

• 표현력이 풍부하고 깔끔하며 주석이 거의 없는 코드가, 복잡하고 어수선하며 주석이 많이 달린 코드보다 훨씬 좋다. 

TIL (Today I Learned) 날짜

2022-04-29

오늘 읽은 범위

4장 주석

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

• 코드만이 정확한 정보를 제공하는 유일한 출처다. (p69)

• 코드를 추가하는일반적인 이유는 코드 품질이 나쁘기 때문이다. 표현력이 풍부하고 깔끔하며 주석이 거의 없는 코드가, 복잡하고 어수선하며 주석이 많이 달린 코드보다 훨씬 좋다. (p69)

• 많은 경우 주석으로 달려는 설명을 함수로 만들어 표현해도 충분하다.(p70)

• 모든 함수에 Javadocs를 달거나 모든 변수에 주석을 달아야한다는 규칙은 어리석기 그지없다 

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

• 닫는 괄호에 주석을 달아야겠다는 생각이 든다면 대신에 함수를 줄이려 시도하자. (p85)

• 주석으로 처리된 코드는 다른 사람들이 지우기를 주저한다. (p86)

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

• 나는 의미없는 주석을 참 많이 달았던 것 같다. 특히 Javadocs를 다 달아야한다고 생각했다. 해외에서 일을 했는데, 특히 영어에 취약한 사람들이 많아서 주석으로 다 번역을 해놓았다.

• 앞으로는 Javadoc이 반드시 필요하지 않다는 것을 염두에 두고 소스코드로 말할 수 있도록 고민하고 개선해야겠다.

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

• 이 책을 읽고 나서 자바독이 필수가 아니라는 것은 알겠지만, 사실 주석을 다는 것은 개발자들이 알아볼 수 있게 하는 것인데 규모가 큰 시스템일수록 사양이 비슷한 용어가 많은데, 주석을 달아서 명확히 하는 것이 좋지 않을까

• 예를 들어 소득액, 소득금액, 보험료, 보험금과 같이 영단어도 이것이 정확히 어떤 의미인지 알 수 없는 경우가 있을 것 같은데, 그 분야의 전문가가 본다면 쓸데없는 내용일 수 있겠지만, 개발자에게 필요하다면 그것은 좋은 주석인가, 나쁜 주석일까.

오늘 읽은 다른사람의 TIL

cjsgkwkd4님의 TIL : https://nomadcoders.co/community/thread/4820

rlaehddlf369님의 TIL : https://nomadcoders.co/community/thread/4806