주석 달기

[kyw0716]

예시:

/**

• @params {string} name 이름을 입력 해주세요
• @params {number} age 나이를 입력 해주세요
• @returns 이름과 나이를 합쳐서 하나의 문자열로 반환해줍니다
  */

function hello(name: string, age: number) : string {
return (${name}님은 ${age}살 입니다.)
}

요런 느낌으로 주석 달기

[kyw0716]

참고 링크: https://youtu.be/ORmnc-hLrYs

[kyw0716]

• 주요 기능을 하는 함수들에 주석 다 달기
• 어떤 함수를 만들고 완성 못했을 시 @todo로 주석 달기

[kyw0716]

클린 코드를 읽어보니 주석을 사용해야만 하는 코드는 좋지 못한 코드라는 것을 알게됨. 주석이 필요 없을 정도로 직관적인 함수를 만들어보자.