回答:
現在、正しい構文はTSDocで使用されている構文です。Visual Studio Codeまたはその他のドキュメントツールでコメントを理解できるようになります。
構文の適切な概要は、ここ(特にここ)にあります。正確な仕様は「すぐに」書かれるべきです。
チェックする価値のある別のファイルは、便利な標準タグが表示されるこのファイルです。
注:TSDocメインページで説明されているように、JSDocを使用しないでください。なぜJSDocを標準にできないのですか?残念ながら、JSDoc文法は厳密には指定されていませんが、特定の実装の動作から推測されています。標準のJSDocタグの大部分は、プレーンなJavaScriptの型注釈を提供することに夢中になっています。これは、TypeScriptなどの強く型付けされた言語には関係のない問題です。TSDocはこれらの制限に対処すると同時に、より高度な一連の目標に取り組みます。
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()
}
これにより、VS Codeなどのエディターはそれを次のように表示します。
/**
押しtab
ます。vs-codeは、JSDocコメントにパラメーターを入力するのに役立ちます
通常のJavaScriptのようにコメントを使用できます。
TypeScript構文は、Ecmascript 5(ES5)構文のスーパーセットです。[...]
このドキュメントでは、TypeScriptによって追加された構文文法について説明します
それ以外は、言語仕様のコメントについてのみこれを見つけました。
TypeScriptは、JavaScriptプログラマーにオプションの型注釈のシステムも提供します。これらの型注釈は、ClosureシステムにあるJSDocコメントに似ていますが、TypeScriptでは言語構文に直接統合されています。この統合により、コードが読みやすくなり、型注釈を対応する変数と同期するためのメンテナンスコストが削減されます。
11.1.1ソースファイルの依存関係:
フォームのコメントは
/// <reference path="..."/>
、path引数で指定されたソースファイルへの依存関係を追加します。パスは、含まれているソースファイルのディレクトリを基準にして解決されます。
ソース:https :
//github.com/Microsoft/TypeScript/blob/master/doc/spec.md