有没有评论JavaScript代码的工具？

有没有像c#like ghost doc那样的javascript注释工具

/// <summary>
///   Method to calculate distance between two points
/// </summary>
/// <param name="pointA">First point</param>
/// <param name="pointB">Second point</param>
function calculatePointDistance(pointA, pointB)
 { 
    ... 
 }

//
///计算两点间距离的方法
/// 
///第一点
///第二点
函数calculatePointDistance（点A、点B）
{ 
... 
}

没有任何工具可以自动添加上述注释。 就像在c#代码中幽灵医生做的那样：

/// <summary>
///   Method to calculate distance between two points
/// </summary>
/// <param name="pointA">First point</param>
/// <param name="pointB">Second point</param>
private void calculatePointDistance(pointA, pointB)
{
  .....
}

//
///计算两点间距离的方法
/// 
///第一点
///第二点
专用void calculatePointDistance（点A、点B）
{
.....
}

我想在客户端做类似的事情，javascript是的（但更像Javadoc）—— 基本上，您可以在注释中使用类似Javadoc的特殊语法，例如下面的示例中的

@param

，然后解析器将为您生成好看的HTML输出

/**
* Shape is an abstract base class. It is defined simply
* to have something to inherit from for geometric 
* subclasses
* @constructor
*/
function Shape(color){
    this.color = color;
}

---

我没有亲自使用过它，但似乎正是您想要的。

简短的回答是没有，没有任何东西可以自动生成文档。您得到的结果是手动添加注释，类似这样可以将文档构建到html页面中

还有针对javascript的javascript的intellisense文档，如下所示（注意它在函数内部）

函数示例（var myParameter）{
///这是一个示例函数
///你所有的绳子都是我们的。
/// 
return！！我的参数；
}

---

您还可以为javascript文件创建代码段。我只需要创建一些代码片段来填充常见文档（您喜欢的任何类型），然后您可以只键入代码片段，它将为您填充大部分文档。

我没有将其用于JavaScript，但这允许（至少在某种程度上）将其用于JavaScript文档。这可能值得研究，特别是如果您使用的是Doxygen也支持的其他语言，那么您可以使用一种工具来处理所有问题

---

JSUnit似乎使用Doxygen作为其文档。

Sandcastle似乎也支持JavaScript，请参阅。我在C#中使用它，因为NDoc项目是toast，但还没有在JavaScript中尝试过。我曾经使用过上面提到的JSDoc。

我想知道为什么没有人在Ghostdoc博客上提到，团队成员直接回答说，他们不支持，也不打算支持JavaScript。无论如何，autodocumentig是邪恶的，你最好用一些手工工作来记录你的代码。他正在寻找一个Visual Studio插件，可以自动创建XML文档。GhostDoc创建文档存根，这样开发者就不必自己编写文档了。（-1来自我）…你的观点是什么？如果你读了我的评论-Ghostdoc不会为他做这件事-所以我为他提供了一个有价值的选择。或者你只是喜欢它？他在寻找一个第三方插件，该插件的工作原理与GhostDoc类似，但用于Javascript。GhostDoc首先不会支持JS，但这并不意味着其他人不会。我们的想法是获得一个插件，为Javascript添加XML文档，这样我们就不必手动键入所有XML元素，而只需键入它们的值（和类型）。是的，我试过了，但我从未让过滤器工作：（Javascript没有键入参数…只是一个输入错误，修复了方法签名

function example(var myParameter){
    /// <summary>This is an example function</summary>
    /// <param name="myParameter" type="String">All your string are belong to us.</param>
    /// <returns type="Boolean" />

   return !!myParameter;
}