Question

有没有办法根据函数实现生成参数信息（jsdoc样式）？

/**
 * 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)

Answer 1

有像docthis（对于Visual Studio Code）这样的编辑器插件可以为你做这件事，但是因为JavaScript是动态类型的，所以它永远不会像你为C＃获得的那样好。同样的扩展也适用于TypeScript文件，您可以获得更多运气并获得更精确的定义（如果您没有使用它，作为C＃开发人员，您可能会喜欢TypeScript）。在TypeScript中编写它是一种很好的方法，可以自动生成具有良好类型信息的JSDoc注释，然后在保持这些注释完整的同时编译为JavaScript。

（编辑：我假设您希望编辑器自动推断并为您写出参数类型。如果您对它只是创建带有名称的样板文件没有别的，VS Code支持这个开箱即用的只需键入/**并按Tab键，其他编辑器肯定会在插件后面具有相同的功能。）

Answer 2

在大多数编辑器中backslash(/)后跟两颗星（**）＆amp;输入/返回将生成function信息。

但在此之前，需要使用参数

定义函数

JSDOC可以帮助记录javascript。它适用于intellij和＆amp;视觉工作室。对于visual studio，该插件可以从here

获得

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

有没有办法在javascript中生成param信息

2 个答案: