如何在 Javascript 文件中编写自己的智能感知注释？

Question

在 C# 中，我可以在类或函数的定义之前添加以 /// 开始的注释，这些注释会影响我编写使用该类型或函数的代码时显示的智能感知提示。但它在 JavaScript 中不起作用。我可以获得这些特别评论和额外提示吗？

Answer 1

对于截至本评论当前日期的 VS 2017+，您需要使用 JSDoc for TypeScript。此示例中的

{string}

表示 param1 是字符串类型，其中“param1”是参数的名称。

@param

是必要的关键字，表示后面是参数的intellisense/JSDoc描述。您可以在其自己的行中为每个附加参数添加一个“

@param

”。文本“此函数的第一个参数”代表您希望智能感知/JSDoc 显示为参数描述的内容。

/**
 * A description for myFunction.
 * @param {string} param1 - The first argument to this function
 */
function myFunction(param1) {
...
}

• JSDoc 参考
• MSDN
• VS Wiki 的 JS

Answer 2

不是很远，但是注释应该在js函数中。

这是一个例子：

function getArea(radius)
  {
      /// <summary>Determines the area of a circle that has the specified radius parameter </summary>
      /// <param name="radius" type="Number">The radius of the circle.</param>
      /// <returns type="Number">The area.</returns>
      var areaVal;
      areaVal = Math.PI * radius * radius;
      return areaVal;
  }

您还可以在 MSDN 中找到 HowTo 和 doc。