JSDoc（VSDでモジュールの型で関数をドキュメント化するため）

Question

http.ClientRequest型パラメータを使用する別のモジュールで記述された関数をドキュメント化したい。私はこのような何かをしたいが、それは動作しません：

/** 
* @param {ClientRequest} req 
*/ 

function setToken(req) { 
} 

私も@param {http.ClientRequest}を試してみましたが、それは動作しませんでした。

更新： 基本的に私はimport http from "http";により、必要なモジュールをインポートすることで、その問題を解決しました。しかし、このモジュールはhttp moduleを使用せず、ヘルパー機能を提供しているので、インポートしたくありません。

Answer 1

JSDocがわからないカスタムタイプなので動作しません。 @typedefで独自の定義をセットアップする必要があります。

/** 
* A number, or a string containing a number. 
* @typedef {(number|string)} NumberLike 
*/ 

/** 
* Set the magic number. 
* @param {NumberLike} x - The magic number. 
*/ 
function setMagicNumber(x) { 
} 

JSDoc typedef tag definition examples

のフル例を参照してください私は、httpという名前のモジュールがあるJSDocのNodeJsで3.5.3

/** @typedef {ClientRequest} TestReq */ 

/** 
* @param {TestReq} req 
*/ 
function setToken(req) { 
} 

JSDoc output image