2017-11-23 3 views
0

@paramを使用して正しくコールバックを文書化する方法がわからないので、Visual Studio 2017 intellisenseはそれを理解します。例えばVisual Studio intellisense用のJSDocでコールバックパラメータを文書化する方法は?

/** 
* @param {string} file absolute path 
* @param {Function} callback called when done 
*/ 
function loadFile(path, callback) { 
    /// code 
} 

コールバックは、それを文書化する方法を、引数(Node.jsのスタイル)としてErrorstringを受け入れますか?

答えて

1

このパターンは動作します:ここに

/** 
* @param {string} file absolute path 
* @param {function(Error, string):void} callback called when done 
*/ 
function loadFile(path, callback) { 
    /// code 
} 

voidはノーリターン値を表し、コールバックの戻り値(例えば:述語のため{function(value):boolean})と交換することができます。

パラメータ名を文書化する方法わかりません。

+0

あなたは私のヒーロー、@tomáš-zatoです。私は公式のJSDoc表記法をコールバックに使用しようとしましたが、これを見るまでは何もできませんでした。私はこの回答を複数回アップヴォートすることができたらいいと思う。 –

+0

変数名と説明でパラメータに注釈を付ける方法を知ることができたら、ボーナス! –

+1

@KrisOye欲しいです。私はすべての種類の組み合わせを成功させずに試みました。 –

関連する問題