有没有一种方法可以在JavaScript中生成参数信息

有没有一种方法可以根据函数实现生成参数信息（jsdoc样式）？有没有一种方法可以在JavaScript中生成参数信息

/** 
 * Assign the project to a list of employees. 
 * @param {Object[]} employees - The employees who are responsible for the project. 
 * @param {string} employees[].name - The name of an employee. 
 * @param {string} employees[].department - The employee's department. 
 */

我会给你一个例如在另一个编辑器。在Microsoft Visual Studio中，你可以在函数上面输入///，它会自动为你写出xml注释。

/// <summary> 
    /// 
    /// </summary> 
    /// <param name="input1"></param> 
    /// <param name="input2"></param> 
    /// <returns></returns> 
    public static decimal Add(string input1, string input2)

来源

2017-10-13 Rod

AFAIK jsdoc风格类似于Javadoc中，你想做什么？文档注释通常取决于IDE /编辑器功能。 –

有没有办法在Visual Studio或VS Code中做到这一点？ – Rod

您可以在这里阅读Intellisense对JSDoc的支持：https：//msdn.microsoft.com/en-us/library/mt162307.aspx。标签名称与C＃文档类似，但以“@”开头。 –

有编辑器插件，像docthis（对于Visual Studio代码），可以为你做这个，但是，因为JavaScript是动态类型的，它永远不会是因为什么，你会得到C＃一样好。同样的扩展也适用于TypeScript文件，在那里你会有更多的运气和更精确的定义（如果你还没有使用它，作为C＃开发者，你可能会喜欢TypeScript）。它可以是一种很好的方法来编写TypeScript，自动生成带有良好类型信息的JSDoc注释，然后编译为JavaScript，同时保持这些注释不变。编辑：我想你希望编辑器自动推断并写出你的参数类型，如果你只是用名称创建样板文件，但没有其他的，VS代码支持这个开箱即用通过只输入/**和按Tab键，和其他编辑肯定有一个插件后面相同的功能。）

来源

2017-10-13 04:22:46

在大多数其次是二星级（**）&输入/回报将产生function信息编辑backslash(/)的。

但该功能之前需要与参数

JSDOC可以记录javascript.It帮助定义既intellij &视觉工作室的作品。对于Visual Studio，该插件可以从here

对于崇高的文本DocBlockr是一个有用的包

来源

2017-10-13 04:25:28 brk

有没有一种方法可以在JavaScript中生成参数信息

回答

相关问题