코드는 의미를, 주석은 의도를
•
코드에 표현하지 못한 어떤 의도를 전달해야 할 때는 주석을 쓸 수밖에 없다.
letsEatSomething : 밥 먹자는 의미의 함수
letsEatSomething() // 내가 배고픈 상황 (의도를 표현)
letsEatSomething() // 네가 배가 고픈 상황 (의도를 표현)
JavaScript
복사
•
개발자가 어떤 의도를 전달하는 이유는 다른 개발자를 위한 것
•
이유를 알려주는 것
•
개발자가 새롭게 발견한 것
•
예상 질문과 답
•
다른 사람에게 보완을 요청하는 것
•
개발자의 속마음을 표현하는 것
주석의 반복
•
코드를 처음부터 읽지 않고, 필요할 때 특정 함수를 검색해서 보는 경우에는 반복된 주석이 필요할 수도 있다.
•
주석이 언제 어떻게 읽히는지에 따라 반복해서 쓸 것인지를 결정해야 한다.
주석의 발췌와 요약
•
주석 내용 중 중요한 것을 뽑아내고 덜 중요한 부분을 빼야 한다.
•
함수의 조건문 내용을 설명하는 주석보다는 조건문의 의미를 주석으로 요약하는 게 더 좋다.
주석도 코드다
•
IDE가 발전했어도 주석을 디버깅해주는 기능은 아직 없다.
•
잘못된 주석을 방치하면 주석에 대한 신뢰가 떨어진다.
•
주석도 코드라는 생각으로 항상 꼼꼼하게 다루어야 한다.
