TypeScript 코멘트의 구문은 어디에 기재되어 있습니까?

TypeScript 코멘트의 구문은 어디에 기재되어 있습니까?

TypeScript 코멘트 구문은 문서화되어 있습니까?

혹시 C#을 지원하게 되었습니까?///시스템?

현재의

TypeScript 팀과 관련된 다른 TypeScript 팀이 TSDoc 사양을 작성했습니다.https://tsdoc.org/

문서에서 직접 예시:

export class Statistics {
  /**
   * Returns the average of two numbers.
   *
   * @remarks
   * This method is part of the {@link core-library#Statistics | Statistics subsystem}.
   *
   * @param x - The first input number
   * @param y - The second input number
   * @returns The arithmetic mean of `x` and `y`
   *
   * @beta
   */
  public static getAverage(x: number, y: number): number {
    return (x + y) / 2.0;
  }
}

과거.

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;
}

업데이트 2020년 11월

모든 TSDoc 구문을 이용할 수 있는 웹사이트가 온라인 상태가 되었습니다(이것만으로도 훌륭합니다). https://tsdoc.org/

---

참고로 오래된 답변:

이제 올바른 구문은 에 의해 사용됩니다.TSDocVisual Studio Code 또는 기타 문서 도구로 의견을 이해할 수 있습니다.

구문의 개요는 여기에서 볼 수 있으며, 특히 여기에서 볼 수 있습니다.정확한 사양은 "곧" 작성되어야 합니다.

이 파일에는 유용한 표준 태그가 있습니다.

주의: TSDoc 메인페이지에서 설명한 바와 같이 JSDoc을 사용하지 마십시오.JSDoc이 표준이 될 수 없는 이유는 무엇입니까? 유감스럽게도 JSDoc 문법은 엄격하게 지정되어 있지 않고 특정 구현의 동작에서 유추됩니다. 표준 JSDoc 태그의 대부분은 플레인 JavaScript에 대한 유형 주석을 제공하는 데 몰두하고 있으며, 이는 TypeScript와 같은 강력한 유형의 언어와는 관련이 없습니다. TSDoc는 이러한 제한에 대처하는 한편, 보다 고도의 목표에도 임하고 있습니다.

다음과 같은 방법으로 파라미터, 반환 등에 대한 정보도 추가할 수 있습니다.

/**
* 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()
}

그러면 VS 코드와 같은 편집자가 다음과 같이 표시합니다.

일반 JavaScript에서와 같은 코멘트를 사용할 수 있습니다.

1 처음에

[...] TypeScript 구문은 ECMAScript 2015(ES2015) 구문의 상위 집합입니다.

2 기본 개념

[...] 이 문서는 TypeScript [...]에서 추가된 구문 문법에 대해 설명합니다.

출처: TypeScript 언어 사양

---

이 사양에서 "comments"라는 단어의 언급은 다음 두 가지뿐입니다.

1 처음에

[...] TypeScript는 JavaScript 프로그래머에게 옵션 유형 주석 시스템도 제공합니다.이러한 유형의 주석들은 Closure 시스템에 있는 JSDoc 주석과 비슷하지만 TypeScript에서는 언어 구문에 직접 통합됩니다.이 통합을 통해 코드 가독성이 향상되고 유형 주석을 해당 변수와 동기화하기 위한 유지 관리 비용이 절감됩니다.

11.1.1 소스 파일의 의존 관계

의 [...]/// <reference path="..."/>는 path 인수로 지정된 소스 파일에 대한 의존 관계를 추가합니다.경로는 포함된 소스 파일의 디렉토리를 기준으로 해결됩니다.

TypeScript는 JavaScript의 엄밀한 구문적 슈퍼셋이기 때문에

• 한 줄 코멘트는 //로 시작합니다.
• 여러 줄의 코멘트는 /*로 시작하여 */로 끝납니다.

언급URL : https://stackoverflow.com/questions/23072286/where-is-the-syntax-for-typescript-comments-documented