Github 项目仓库:https : //github.com/Fralleee/lerna-intellisense-jsdoc-vscode
我有一个包含两个包(Web 和 Api)的 monorepo 项目,它们使用 lerna 链接。Web 项目导入了 Api 包,并且使用 JSDoc 记录了 Api 请求。
如果 Api 包发布并从 NPM 导入,文档将被完美加载。

但是,如果它通过 lerna 和 webpack devserver 在本地运行,则文档将丢失并且仅在本地代码中可用(在 Api 文件夹中)。

我曾尝试使用模块、命名空间和搜索不同类型的解决方案来编写文档,但似乎都不起作用。
JSDoc 和功能:
/**
* Get comments from jsonplaceholder API
* @namespace API
* @module
* @param {GetCommentsRequestExample} input PostId
* @returns {Promise.<GetCommentsResponseExample>} Array of comments
*/
export const getComments = input => apiGet('https://jsonplaceholder.typicode.com/comments', input, GetCommentsRequest, GetCommentsResponse)
Run Code Online (Sandbox Code Playgroud)
我不明白为什么 JSDoc 在包发布时有效,但在本地运行时无效。
经过 2 小时的额外测试后编辑
我使用 Api 包中的索引文件导出所有内容。此索引文件从包中导入所有内容,然后将其导出,有点像单一入口点。
如果我直接在此索引文件中定义函数和 JSDoc,则 …