Question

是否有任何javascript评论工具，因为它在c＃中像ghost doc。

/// <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＃code ghost doc中做过：

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

Answer 1

是（但更像是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;
}

Answer 2

简短的回答是否定的，没有什么可以自动化文档。您得到的结果是手动添加jsdoc-toolkit之类的注释，允许将文档构建到html页面。

javascript也有javascript的intellisense文档，看起来像这样（注意它在函数内部）

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文件创建代码段。我只想创建一些代码片段来填写常用文档（您喜欢的任何类型），然后您只需键入代码段，它就会为您填写大部分文档。

Answer 3

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

Answer 4

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

Answer 5

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

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

Answer 6

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。

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

6 个答案: