개발자 99% 커뮤니티에서 수다 떨어요!
오늘 TIL 3줄 요약
주석은 웬만해서 달지 않는 것이 좋다.
주석으로 설명이 필요하다면 함수를 새로 짜는 것이 좋다.
주석이 아니라 코드로 의도를 표현하라.
TIL (Today I Learned) 날짜
2022. 04. 28
오늘 읽은 범위
4장. 주석
책에서 기억하고 싶은 내용을 써보세요.
나쁜 코드에 주석을 달지 마라. 새로 짜라.
주석은 기껏해야 필요악. 프로그래밍 언어로 의도를 표현해낸다면 주석은 거의 필요하지 않다.
코드로 의도를 표현하지 못해, 실패를 만회하기 위해 주석을 사용. 주석은 언제나 실패를 의미한다.
코드는 변화하고 진화한다. 하지만 주석은 언제나 코드를 따라가지 않는(못한)다. 결국 주석은 코드에서 분리되어 점점 더 부정확한 고아로 변한다.
부정확한 주석은 아예 없는 주석보다 훨씬 나쁘다.
진실은 코드에만 존재한다. 코드만이 정확한 정보를 제공하는 유일한 출처이다.
주석은 나쁜 코드를 보완하지 못한다.
표현력이 풍부하고 깔끔하며 주석이 거의 없는 코드가 복잡하고 어수선하며 주석이 많이 달린 코드보다 훨씬 좋다.
코드로 의도를 표현하라. 많은 경우 주석으로 달리는 설명을 함수로 만들어 표현해도 충분하다.
좋은 주석
법적인 주석 (ex. 저작권 정보, 소유권 정보)
정보를 제공하는 주석
But, 가능하면 함수 이름에 정보를 담는 편이 더 좋다.
의도를 설명하는 주석
때때로 주석은 구현을 이해하게 도와주는 것을 넘어 결정에 깔린 의도까지 설명한다
의미를 명료하게 밝히는 주석
결과를 경고하는 주석. 다른 프로그래머에게 결과를 경고할 목적
TODO 주석
중요성을 강조하는 주석
공개 API에서 Javadocs
나쁜 주석
주절거리는 주석. 이해가 안되어 다른 모듈까지 뒤져야 하는 주석은 독자와 제대로 소통하지 못하는 주석
같은 이야기를 반복하는 주석
주석은 코드보다 더 많은 정보를 제공하지 못한다.
오해할 여지가 있는 주석
의무적으로 다는 주석
이력을 기록하는 주석
있으나 마나 한 주석(새로운 정보를 제공하지 못하는 주석)
무서운 잡음
함수나 변수로 표현할 수 있는 주석
위치를 표시하는 주석. 이를 남용하면 독자가 흔한 잡음으로 여겨 무시
닫는 괄호에 다는 주석
닫는 괄호에 주석을 달아야겠다는 생각이 든다면 대신 함수를 줄이려 시도하자.
공로를 돌리거나 저자를 표시하는 주석
소스코드 관리 시스템에 저장해라.
주석으로 처리한 코드
소스코드 관리 시스템이 우리를 대신해 코드를 기억해준다. 그냥 삭제하라.
HTML 주석
전역 정보. 주석을 달아야 한다면 근처에 있는 코드만 기술하고 시스템 전반적인 정보를 기술하지 마라
너무 많은 정보
모호한 관계. 주석과 주석이 설명하는 코드는 둘 사이 관계가 명백해야 한다.
함수 헤더
짧고 한 가지만 수행하며 이름을 잘 붙인 함수가 주석으로 헤더를 추가한 함수보다 훨씬 좋다.
비공개 코드에서 Javadocs
오늘 읽은 소감은? 떠오르는 생각을 가볍게 적어보세요
코드를 짜는 것은 글쓰기와 같으므로 독자가 코드를 보고 이해할 수 있도록 짜야한다. 코드만으로 이해가 되지 않아 부가적인 설명이 필요하다는 것은 글을 제대로 쓰지 못했다는 의미이다. 부가적인 설명을 넣기 보다는 그 시간에 독자들이 이해할 수 있도록 코드를 새로 짜자.
거의 무조건 주석이 있는 코드보다 주석 없이도 의도가 드러나는 깔끔한 코드가 좋다.
궁금한 내용이 있거나, 잘 이해되지 않는 내용이 있다면 적어보세요.
오늘 읽은 다른사람의 TIL