javascript函数文档新手问题

Question

新手提醒！

当您在下面的代码中需要一个模块，并且将鼠标悬停在从该模块进行调用的函数上时，您会弹出有关该函数的一些文档，例如参数，返回和抛出等

const AWS = require("aws-sdk");
const cognito = new AWS.CognitoIdentityServiceProvider({ apiVersion: "2016-04-18" });

在我自己的模块中，我先编写了函数，然后又要求他们按照以下示例记录了每个函数

/**
 * Given a user's profile, create a new session (kill any previous sessions)
 * @param profile The users profile
 * @throws Exception if the user is not a valid user.
 */ 

当我将鼠标悬停在包含功能代码的模块中的功能上时，我会看到出现文档框。

但是，当我将函数悬停在实际调用该函数的模块中时，却什么也没得到。

您还将获得智能感知类型功能，因此当您键入cognito时。您会弹出所有可用功能的弹出窗口。

缺少什么让我的功能也能像这样出现？它们都是使用

导出的

module.exports.funcName = funcName;

有人吗？

预先感谢

Answer 1

希望这可以帮助其他新手像我一样做愚蠢的事情。

终于找到了我问题的答案。基本上，我在本地笔记本电脑上的路径与构建服务器上的路径并不完全相同，因此我的本地js文件具有定义为适合构建服务器的路径。这意味着在本地文件上，这些文件将无法正确解析，因此将不会导入js doc refs。

一旦我在本地服务器和构建服务器上对齐了路径，然后正确导入了文件，并且viola JS文档开始正常工作。

Do！