有什么工具可以评论JavaScript代码吗？

是否有任何JavaScript评论工具，因为它在C＃就像幽灵文档。有什么工具可以评论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) 
{ 
    ... 
}

有任何工具来自动添加上述评论。像在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) 
{ 
    ..... 
}

我想做的事情在客户端上的类似，JavaScript的

来源

2009-10-20 Vijjendra

在Ghostdoc博客有一个从他们不和不打算支持JavaScript团队成员直接回答。无论如何 - autodocumentig是邪恶的，你最好在编写代码时进行一些手动工作 – Bostone 2009-10-20 17:02:21

是（但更喜欢的Javadoc） - look at JSDoc 基本上你使用类似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; 
}

来源

2009-10-20 16:19:15 Bostone

他在Visual Studio插件之后会自动创建XML文档。 GhostDoc创建文档存根，因此开发人员不必自行编写所有文档。（从我的-1）... – 2009-10-20 20:37:03

你有什么意见？如果你阅读我的评论 - Ghostdoc不会为他做 - 所以我提供了一个有价值的替代人。或者你只是喜欢它？ – Bostone 2009-10-20 21:22:45

他在第三方插件之后，其工作方式与GhostDoc类似，但是适用于Javascript。 GhostDoc首先不会支持JS，这并不意味着别人不会。这个想法是获得一个为Javascript添加XML文档的插件，所以我们不必手动输入所有的XML元素，而只是输入他们的值（和类型）。 – 2014-01-27 12:02:58

我没有亲自使用过，但jsdoc-toolkit似乎是你追求的。

来源

2009-10-20 16:20:00 etheros

简短的答案是否定的，没有什么能自动执行文档。你得到的关闭是手动添加注释，如jsdoc-toolkit，允许将文档构建到html页面中。

有对JavaScript的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; 
}

您还可以创建JavaScript文件片段。我只需创建一些填写常用文档（您喜欢的任何类型）的代码片段，然后只需键入代码片段即可填写大部分文档。

来源

2009-10-20 16:44:19

Javascript没有输入参数... – 2014-05-16 18:56:26

只是一个错字，修复了方法签名 – 2014-05-23 17:50:52

我还没有用它来做JavaScript，但是Doxygen has a filter允许它（至少在某种程度上）用来记录JavaScript。这可能是值得研究的，特别是如果您使用Doxygen也支持的其他语言，那么您可以拥有一切工具。

看来，JSUnit使用Doxygen作为其文档。

来源

2009-10-20 16:48:48

雅，我试过，但我从来没有得到该过滤器工作:( – 2009-10-21 00:48:39

Sandcastle似乎也支持JavaScript，请参阅http://blogs.msdn.com/sandcastle/archive/2007/06/28/scriptdoc-1-0-for-extractiong-javascript-code-comments-is-now-available-at-codeplex.aspx。我将它用于C＃，因为NDoc项目是吐司，但还没有尝试过用于JavaScript。我曾经使用上面提到的JSDoc。

来源

2009-10-20 16:59:25 nickytonline

我不知道为什么没有人提到DocStubsJS

来源

2015-09-29 02:44:36

有什么工具可以评论JavaScript代码吗？

回答

相关问题