javascript函数文档新手问题答案

【问题标题】：javascript function documentation newbie questionjavascript函数文档新手问题
【发布时间】：2018-11-28 21:17:44
【问题描述】：

新手提醒！！

当您在代码中需要一个模块（如下所示）并将鼠标悬停在从该模块调用的函数上时，您会弹出一些关于该函数的文档，即参数、返回和抛出等

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;

有人吗？

提前致谢

【问题讨论】：

可能有助于包含您正在使用的编辑器以及可能影响此功能的任何编辑器扩展。
嗨 @KevinB VS Code 是我的编辑器启用扩展 Bracket Pair Colorizer Cloudformation Debugger for Chrome Docker ESLint GraphQL Import Cost indent-rainbow Quokka SVN

标签： javascript code-documentation

【解决方案1】：

希望这对其他像我一样做傻事的新手有所帮助。

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

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

哇！

【讨论】：