最新消息:雨落星辰是一个专注网站SEO优化、网站SEO诊断、搜索引擎研究、网络营销推广、网站策划运营及站长类的自媒体原创博客

VS代码中的JSDoc,用于记录具有模块类型的函数

运维笔记admin11浏览0评论

VS代码中的JSDoc,用于记录具有模块类型的函数

VS代码中的JSDoc,用于记录具有模块类型的函数

我想记录一个用另一个模块编写的函数,它使用http.ClientRequest类型参数。我想要这样的东西,但它不起作用:

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

function setToken(req) {
}

我也试过@param {http.ClientRequest},但它没有用。

更新:基本上我通过import http from "http";导入所需的模块解决了这个问题。但是,我不想导入它,因为该模块不使用http module但提供辅助函数。

回答如下:

在改进了IGx89的答案后,我得到了一个没有typedef的较短变种。当我一次引用另一个模块时,我更喜欢这个变体:

/**
* @param {import('http').ClientRequest} req 
*/
function setToken(req) {

}

但是,如果您需要从具有长路径变量的另一个模块引用某些类型,并且typedef看起来更短。

发布评论

评论列表(0)

  1. 暂无评论