주석은 무엇인가

주석은 최대한 사용 No!

// 직원에게 복지 혜택을 받을 자격이 있는지 검사한다.
if((employee.flags & HOURLY_FLAG) && employee.age > 65)
  
// 의미있는 이름으로 상황을 해결
if(employee.isEligibleForFullBenefits())

• 주석은 자신이 작성한 코드에대해 확신이 부족하다고 생각할때 작성하는 경우가 대부분
• 부족하다고 끝내지 말고 코드를 개선을 하자
• 첫번째 이유로 작성된 주석은 방치된다
  • 담당자가 변경됐을때
  • 코드 기능을 변경했는데 혹시몰라서 남겨두는경우
  • 그렇게 쌓인 주석은 다른 개발자들을 점점 혼란스럽게 만들게 됨

주석을 사용하려면

// kk:mm:ss EEE, MMM dd, yyyy 형식

const date = Pattern.compile("\\d*:\\d:\\d* \\w*, \\w* \\d* \\d*");

• 정규식 표현같이 직관적으로 어떤걸 나타내는지 설명이 필요한경우
• 겉으로 봤을땐 비효율적이고 불필요한 코드지만 테스트라든지 기타 이유로 꼭 필요한 기능일 경우
• TODO 앞으로 구현해야하는 기능을 명시
• 당장은 돌아가지만 고쳐야할 필요가 있는 코드들에 대해서 표시하는 용도

주석보다는 annotation

• VSC 같은 경우 함수에 대해 어떤 인자가 들어가고 어떤 타입이 리턴되는지 표시되면서 함수에 대한 설명을 요즘 추가할 수 있다