4

我还是 Javascript 的新手，所以当我的编辑突出显示它时，我很感兴趣。它到底是做什么的？

例子：/// things go after here

4

4 回答 4

8

一些文档生成器将三个斜杠 /// 视为向 JavaScript 引入文档注释。

看

http://msdn.microsoft.com/en-us/library/bb514138(v=vs.110).aspx

因此，就 JavaScript 而言，三个斜杠与两个斜杠的工作方式相同（它是对行尾的注释），但文档生成器可以解释三个斜杠以指示文档部分。

例子：

  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;
  }
于 2012-05-03T00:14:18.567 回答
2

前两个斜杠开始注释。第三个斜线什么也不做。

JS中主要的两种注释方式：

/* This way
Can go multi-line */

// This way is one line only
于 2012-05-03T00:13:16.667 回答
1

我相信这是在某些编辑器/文档程序中定义“更高级别”单行注释的一种方式：

例如，在 macrabbit 的 espresso 编辑器中，它会在导航窗格中突出显示这些单行注释

于 2012-05-03T00:15:59.537 回答
0

JavaScript（和其他一些语言，如 C#）中的三个斜杠用于文档注释。这些用于生成 XML 文档，并在函数等之前以某种格式完成，以指定函数及其参数和参数类型的描述。

http://msdn.microsoft.com/en-us/library/bb514138(v=vs.110).aspx

于 2012-05-03T00:15:36.653 回答