미래

TypeScript 팀 및 기타 TypeScript 관련 팀은 표준 공식 TSDoc 사양을 만들 계획입니다. 1.0.0초안은 아직 확정되지 않았습니다 https://github.com/Microsoft/tsdoc#where-are-we-on-the-roadmap

흐름

TypeScript는 JSDoc을 사용합니다. 예 :

/** This is a description of the foo function. */
function foo() {
}

jsdoc을 배우려면 : https://jsdoc.app/

그러나 JSDoc에서는 유형 주석 확장명을 사용할 필요가 없습니다.

당신은 (해야하고) 여전히 다른 jsdoc에 사용할 수있는 블록 태그 와 같은 @returns등

예

단지 예입니다. 내용이 아닌 유형에 중점을 둡니다.

JSDoc 버전 (문서의 통지 유형) :

/**
 * Returns the sum of a and b
 * @param {number} a
 * @param {number} b
 * @returns {number}
 */
function sum(a, b) {
    return a + b;
}

TypeScript 버전 (유형 재배치에 유의) :

/**
 * Takes two numbers and returns their sum
 * @param a first input to sum
 * @param b second input to sum
 * @returns sum of a and b
 */
function sum(a: number, b: number): number {
    return a + b;
}

답변

/**
* This is the foo function
* @param bar This is the bar parameter
* @returns returns a string version of bar
*/
function foo(bar: number): string {
    return bar.toString()
}