2017-11-29 1 views
1

すべてのjs関数を記述したパーソナルライブラリを作成したいと思います。
本当に必要なのは、入力変数のタイプ、リターンのタイプ、機能に関する情報など、この機能に関するヒントを私に示すためにVSコードのインテリセンスが必要なことです。 - たとえば は、サブストリングのためのヒントは次のようになります。 enter image description here
と私の機能のためのヒントは次のようになります。私はと.TSファイルがあることを、見つけることができたVSコードのビットを掘る enter image description here

(例えば、lid.es6.d.ts内のサブストリング()の宣言など) enter image description here
私の最初の考えは、自分のすべての関数の宣言で個人用の.tsファイルを作ることができるかどうかですインテリセンスにも言及させるようにしてください。VSコードでパーソナル機能のヒントを作成するには

+0

だけの提案、typescriptです試してみるので、活字体は、あなたが引数の型を指定することができますまた、typescriptですの出力はプレーンTSであるので、あなたが探している素敵なヒントを取得します –

答えて

3

あなたのjavascript関数には.d.tsは必要ありません。jsDocコメントだけを使用できます。例:

/** 
* Does stuff 
* @param {Number} params 
*/ 
function myFun(params) { 


} 

{}は、パラメータのタイプです。関数に説明を追加することもできます。

VsCodeはJsDocのコメントを受け取り、ヒントを示すために使用します。また、/**と入力し、関数の上にあるタブを押すと、関数にフォーマットされたjsDocコメントベースが挿入され、開始点が与えられます。

JSDocの参照here

注: typescriptです試してみてそう、活字体は、あなたが引数の型を指定することができますまた、typescriptですの出力はプレーンTSであるので、あなたが探している素敵なヒントを取得します

+0

の前にライブラリを使用することができる場所ならどこでもあなたのライブラリを使用することができます。ありがとう、明らかに私はJSDocとTypeScriptの両方が必要です。 VSコードがそこから宣言をピックアップし始めるように、どのように/ .tファイルへの参照をどこに置くかについてのアイデアはありますか? – Bobbie

+0

Typescriptでコードを書き込む予定ですか?あるいは、Javascriptを書いて、ヒントを増やすために '.ts'ファイルを使用したいとしますか? –

+0

私はJSコードを記述し、ヒントを表示するために.tsを使用する予定です。ここには私がJSスクリプトを書く作業がありますが、いくつかのAPIがある別のソフトウェアでそれらを実行します。 API関数のドキュメントがありますが、コードはありません。そして、私がこの関数への呼び出しを使うたびに、どれくらいのパラメータがどこにあるのかを確認する必要があります。これはtsファイルが必要なものです。これが理にかなってほしい。一方、私はまだJSDocを使う小さな機能を持っています。 – Bobbie

2

はい、あなたはあなた自身の入力を書くことができました。あなたはTSを使用したくない場合は、JSDocの標準を使用することができます。

/** 
* Get a survey's details and possible answers by id 
* @param {Number} surveyId 
*/ 
const getById = async (surveyId) => { 
    ... 
} 

VSCは、すべてのことを読んで、実装する際に、それを表示するのに十分スマートです。 特に、エクスポートされたサービスとインポートされたサービスを構築すると、これは素晴らしい結果をもたらします。

JSDocの情報:http://usejsdoc.org/about-getting-started.html

関連する問題