2017-01-04 4 views
1

オブジェクト(またはより正確にはノードにmodule.exportsに割り当てられたオブジェクト)があり、このオブジェクトのプロパティが関数で構成されている場合、どのようにパラメータを記述し、関数?オブジェクトのプロパティにJSDocを使用して関数のパラメータを記述する

例:

module.exports = { 
    /** 
    * Adds two numbers together. 
    * @param {number} first The first number 
    * @param {number} second The second number 
    * @return {number} The sum of the two numbers 
    */ 
    "add": function(first, second) { 
     return first + second; 
    } 
} 

これは(少なくともないVSCodeで)サポートされていないようだと、私は、関数の引数を文書化する方法を説明しJSDocのドキュメントの任意の場所で見つけることができませんでしたこのシナリオ(または単なるオブジェクトの場合)。 JSDocの説明が機能します(VSCodeのIntellisenseによって表示されます)。しかし、paramの定義と戻り値の定義は異なります。

関数をドキュメント化して、それらを参照するオブジェクトに表示する方法はありますか?

+0

'vscode'タグは、そのプログラムに固有のものかもしれないので、あなたの質問に追加したいかもしれません。これはIDEの一般的な問題のようです。別の質問があります:http://stackoverflow.com/questions/40877203/intellisense-from-jsdoc-not-working-for-imported-types-in-vscode、これは大文字の詳細です。 https://github.com/Microsoft/vscode/issues/3842も参照してください。これは、最新バージョンのVSCodeで修正されているようです。 –

+0

ありがとうございます。大文字の使用に関するリンクから、私は答えにつながった。 –

答えて

0

これは実際にはVSCodeで正しく機能します。私の問題は、私の@paramタイプには適切な大文字の入力がない(Objectが動作し、objectは動作しない)ということです。これは、Intellisenseが動作しないことを意味します。注:Numbernumberは両方とも問題ありません。また、大文字と小文字の区別も気にしない他の「種類」があると思われます。

関連する問題