책의 예시들을 typescript로 작성하였습니다. 의미가 안 맞을 수 있지만 최대한 비슷한 느낌으로 작성하려 노력했습니다🥺
1. 주석을 최대한 쓰지 말자
주석은 나쁜 코드를 보완하지 못한다.
- 코드에 주석을 추가하는 일반적인 이유는 코드 품질이 나쁘기 때문
- 자신이 저지른 난장판(👀)을 주석으로 설명하지 말고 개선하는데 시간을 보내야 한다.
- 코드로도 의도를 표현할 수 있다.
- ex)
//* 직원에게 복지 혜택을 받을 자격이 있는지 검사한다.
if ((employee.flags & HOURLY_FLAG) && employee.age > 65) {}
// 의미있는 이름을 지으면 해결된다.
if ((employee.isEligibleForFullBenefits()) {}
// -> 별도의 함수로 만들고 boolean값으로 리턴주석은 방치된다.
- 코드의 변화에 따라가지 못하고, 주석은 방치된다.
- 코드는 컴파일되어 호출되지만, 주석은 그저 주석이기 때문에 그 자리에 방치되고 결국 의미없는 텍스트가 되어 버린다.
2. 좋은 주석
- 구현에 대한 정보를 제공한다.
- 의도와 중요성을 설명한다.
TODO,FIXME주석
3. JsDoc
- Javadoc 과 유사
- javascript 용 API 문서 생성기
(ง •̀_•́)ง