有没有评论 JavaScript 代码的工具？ [关闭]答案

【问题标题】：Is there any tool for commenting JavaScript code? [closed]有没有评论 JavaScript 代码的工具？ [关闭]
【发布时间】：2010-12-08 10:08:21
【问题描述】：

有没有像ghost doc一样在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)
 { 
    ... 
 }

有任何工具可以像上面那样自动添加 cmets。就像在 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

【问题讨论】：

在 Ghostdoc 博客上，团队成员直接回答说他们不支持也不打算支持 JavaScript。无论如何 - autodocumentig 是邪恶的，你最好投入一些手动工作来记录你的代码

标签： javascript visual-studio comments

【解决方案1】：

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

【讨论】：

【解决方案2】：

简短的回答是否定的，没有什么可以使文档自动化。您获得的关闭是手动添加带有 jsdoc-toolkit 之类的 cmets，它允许将文档构建到 html 页面中。

也有用于 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 文件创建 sn-ps。我只需创建几个 sn-ps 填写常用文档（您喜欢的任何类型），然后您只需键入 sn-p，它就会为您填写大部分文档。

【讨论】：

Javascript 没有类型参数...
只是一个错字，修复了方法签名

【解决方案3】：

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 项目是 toast，但还没有尝试过用于 JavaScript。我以前用过上面提到的JSDoc。

【讨论】：

【解决方案4】：

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

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

【讨论】：

是的，我试过了，但我从来没有让那个过滤器工作:(

【解决方案5】：

是的（但更像 Javadoc）-look at JSDoc 基本上，您在 cmets 中使用类似 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;
}

【讨论】：

他正在寻找一个可以自动创建 XML 文档的 Visual Studio 插件。 GhostDoc 创建文档存根，因此开发人员不必自己编写所有内容。（-1 来自我）...
你的意思是什么？如果您阅读了我的评论 - Ghostdoc 不会为他做这件事 - 所以我为这个人提供了一个有价值的选择。或者你只是享受它？
他在寻找与 GhostDoc 类似的第三方插件，但适用于 Javascript。 GhostDoc 一开始就不支持 JS，但这并不意味着其他人不会。我们的想法是获得一个为 Javascript 添加 XML 文档的插件，这样我们就不必手动输入所有 XML 元素，而只需输入它们的值（和类型）。

【解决方案6】：

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

【讨论】：