在VS代碼中的JSDoc用於記錄功能與模塊的類型

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

完整的例子，我做這與JSDoc 3.5.3

/** @typedef {ClientRequest} TestReq */ 

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

JSDoc output image