[타입선언, @types 48] 주석 (JSDoc, TSDoc)

사용자를 위한 문서를 만들 때 주석을 달아야 한다면 JSDoc 스타일의 주석으로 만드는 것이 좋다.

1. JSDoc, TSDoc

• /** */ 형식으로 주석을 달면 에디터에서 함수 호출 시 주석을 툴팁으로 표시해준다
• @param, @returns 구문과 문서 서식을 위한 마크다운을 사용할 수 있다
• 주석에 타입 정보를 포함하지 말자

/** 인사말을 생성합니다 */
function greetJS(name :string) {
  return `안녕 ${name}`;
}

/**
 * 인사말을 생성합니다
 * @param name 이름
 * @returns 인사말을 출력합니다
 */

function greetFull(name :string) {
  return `안녕 ${name}`;
}

/** 측정을 위한 _interface_ */
interface Meausrement {
  /** 측정시간 */
  time: number;

  /** 측정 운동량 */
  momentum: number;
}

const A: Meausrement = {
  time: 123,
  momentum: 12
}