如何使用 JSDoc 来记录 JSON 对象内的函数？

Question

我正在尝试在我的 discord 机器人代码中记录函数参数 message 和 client。但我不确定该怎么做。下面是一些大致遵循我的代码的示例代码：

var discord = require("discord.js");

module.exports = {
   name: "exampleCommand",
   aliases: ["example", "example2"],
   execute(message, client){
   message.channel.send("example")
   }
}

我尝试过的一些事情：

/*
 * Execute command
 * @param {discord.Message} message - The message that was sent
 * @param {discord.Client} client - The discord bot client
*/
execute(message, client){
message.channel.send("example")
}
}

我在这里的另一个问题中发现了这个，但也没有做到：

/*
 * @param {name:string, aliases:Array, execute(discord.Message, discord.Client)}
*/
{
    name:"exampleCommand",
    aliases:["example", "example2"],
    execute(message, client){
    message.channel.send("example")
    }
}

我假设我的 IDE（Visual studio 代码）应该自动检测 JSDoc 注释并提供正确的 IntelliSense 建议，但它只是表明它们的类型仍然是 any .在 JSON 中记录此函数的正确方法是什么？

Answer 1

这比我原先想象的要简单得多。我错误地开始了我的 JSDOC 评论。当我本应以 /** 开始时，我却以 /* 开始。这个小修复使一切都按预期工作。

如何使用 JSDoc 来记录 JSON 对象内的函数？

How would one go about using JSDoc to document a function inside of a JSON object?

javascript

jsdoc