2016-07-27 24 views
2

ES6構文では、非構造化変数および引数の名前を変更できます。JSDocを使用する名前を変更した名前の関数引数にどのように注釈を付けることができますか?

変数:

const {requestID: _requestID, notifyChanges: _notifyChanges} = someObject; 
console.log(_requestID, _notifyChanges); 

引数:

/** 
* Creates a cloud ready request. 
* @param {String} requestID Request ID used for for tracing and logs 
* @param {Boolean} [notifyChanges] Send an event to the message queue. 
*/ 
function createRequest({ 
    requestID: _requestID, 
    notifyChanges: _notifyChanges = false, 
}) { 
    console.log(_requestID, _notifyChanges); 
}); 

上記のJavaScriptコードが有効であるにもかかわらず、JSDocのは言ってエラーを示しています。 Parameter 'requestID' described in JSDoc does not appear in function signature

どのように私はきちんとに注釈を付けるだろうしJSDocで関数の引数を再構成して名前を変更しましたか?

答えて

3

JSDocのパラメータ名に使用コロン:

/** 
* Creates a cloud ready request. 
* @param {String} _requestID:requestID Request ID used for for tracing and logs 
* @param {Boolean} [_notifyChanges:notifyChanges] Send an event to the message queue. 
*/ 
function createRequest({ 
    requestID: _requestID, 
    notifyChanges: _notifyChanges = false, 
}) { 
    console.log(_requestID, _notifyChanges); 
}); 

これは、WebStorm IDE 2016.2で試験しました。正常に動作します。

関連する問題