협업을 위한 Javascript/Typescript 주석 작성하기 (JSDoc)

Writing Javascript/Typescript comments for collaboration (JSDoc)

/** @type {string} */
var win;

/**
* 책의 정보를 나타내는 함수입니다.
* @constructor
* @param {string} title - 책의 제목
* @param {string} author - 책의 저자
*/
function Book(title: string, author: string) {
}

/**
 * 숫자를 세제곱합니다.
 * @param {number} x - 입력 숫자
 * @returns {number} x의 세제곱 값
 * @example
 * cube(3); // 27
 */
function cube(x: number): number {
  return x * x * x;
}

/**
 * 이 함수는 더 이상 사용되지 않습니다. 대신 newMethod를 사용하세요.
 * @deprecated
 */
function oldMethod() {
  console.log("이 메서드는 더 이상 사용되지 않습니다.");
}

/**
 * 숫자를 나눕니다.
 * @param {number} x - 나눌 숫자
 * @param {number} y - 나누는 숫자
 * @returns {number} x를 y로 나눈 값
 * @throws {DivideByZero} y가 0인 경우
 */
function divide(x: number, y: number): number {
	if (y === 0) {
		throw new Error("y는 0이 될 수 없습니다.");
	}
	return x / y;
}

/**
 * 비동기적으로 사용자 정보를 가져옵니다.
 * @param {string} userId - 사용자 ID
 * @returns {Promise<User>} 사용자 정보
 * @async
 */
async function fetchUser(userId: string): Promise<User> {
	const response = await fetch(`/users/${userId}`);
	return response.json();
}

/**
 * 숫자 또는 숫자가 포함된 문자열입니다.
 * @typedef {(number|string)} NumberLike
 */
 
/**
 * 매직넘버를 설정합니다.
 * @param {NumberLike} x - 매직넘버.
 */
 function setMagicNumber(x: NumberLike) {
}