Visual Studio 2010 Javascript/jQuery文档

Question

好的，这里有两个问题：

1. 是否有类似于 GhostDoc 的 JS 工具？
2. 有没有可以使用 C# 和 JS 源文件来生成文档的好帮助文件生成器？看起来 SandCastle 不支持网站而是支持包含 .proj 文件的 Web 项目。而且，据我所知，Natural Docs 不支持 Visual Studio 风格的文档…所以那个不行。

我感觉自己漏掉了什么东西。我简直无法相信还有人手动注释 JS 代码...肯定有解决方案，对吧？

我已经四处搜索过了，现在只能求助于你们了。请告诉我这是因为我搜索能力不够，而事实上这些问题都很容易解决！:-)

- imyoac

---

你可以给出一个关于注释的例子吗？你是指严格要求在函数上方添加 ///<summary> 块（以及相关的JavaDocs）吗？还是说你希望这个文档引擎有其他功能？ - jcolebrand

只是标准的、受Intellisense支持的风格... - imyoac

(function ($) { $.fn.helpfulTips = function (options) { /// <summary> /// 有用的提示 /// </summary> /// <param name="options">选项</param> /// <returns>jQuery</returns> var defaults = { pointer: "#theArrow" }; ... - imyoac

你是否成功解决了这个问题？你还需要帮助吗？ - jcolebrand

你为什么要使用网站而不是Web项目？Web项目更容易部署、测试、将外部资源集成，并且更容易选择应该和不应该部署的内容。 - Chris Moschini

Answer 1

您必须通过添加以下内容来引用源中将要使用的所有js文件：

/// <reference path="jquery-1.4.2.min.js" />
/// <reference path="facebox.js" />

在你的 JavaScript 文件的顶部加入以下代码。这样，你可以在 JavaScript 中使用智能感知。

还有一件事，一些 JS 框架（例如 jQuery）具有 -vsdoc.js 文件以进行智能感知。你必须将这些文件放置在原始 js 文件的所在位置，并且它们的名称必须匹配。

如果你的 js 文件名为 "test.js"，那么你的 -vsdoc 文件必须命名为："test-vsdoc.js"。

- Medeni Baykal

Answer 2

您将其作为示例提供（最好将其放在问题中，也许管理员会为您完成此操作，因为您应该能够编辑自己的问题），并且您想知道是否可以自动将/// <summary>块插入代码的javascript部分，而不仅仅是在.cs文件中。

(function ($) { $.fn.helpfulTips = function (options) { 
    /// <summary>  
    /// Helpful Tips 
    /// </summary>  
    /// <param name="options">options</param>  
    /// <returns>jQuery</returns>  
    var defaults = { pointer: "#theArrow" };
    } 
});

我认为应该可以，但是我打这些东西的速度非常快，以至于我没有意识到我在打字。我也倾向于手动完成我的工作，但是我通常不需要对我的代码进行javadoc（我们不使用javadocs），所以我不知道是否有任何自动化工具可以在VS中帮助处理这个问题。我很好奇，所以我会收藏这篇文章，看看是否有其他人对此有好的想法。

- jcolebrand

---

http://weblogs.asp.net/scottgu/archive/2010/02/08/jquery-1-4-1-intellisense-with-visual-studio.aspx - jcolebrand

“javadoc”和VS使用的xml文档风格是同一件事吗？ - imyoac

有关如何生成帮助文件的任何想法？ - imyoac

很遗憾，我不知道。Sandcastle 是我所知道的最先进的工具了。我们只是没有使用 javadoc 或 xmlcomments 的需求，所以我们不会去折腾它们。 - jcolebrand

糟糕。唉，没办法。看来我得自己动手了 :-) 再次感谢你的帮助。我很感激所有的回复。你让我觉得自己并不是疯了！ - imyoac

Answer 3

你可以使用 YuiDoc 来生成类似于 JavaDoc 的输出。我已经使用过它，并且非常满意它提供的输出结果。你需要使用他们的注释格式，这与 Visual Studio 格式不同。

- randomperson25

---

你在Visual Studio项目中使用过YuiDoc吗？你能找到DLL文件还是只安装了Python来运行它？ - Tim Banks

我安装了Python和YuiDoc所需的库。您应该能够创建一个MsBuild任务，在构建时自动运行YuiDoc，或者在Visual Studio的工具菜单下使用“外部工具屏幕”设置一种方便的方式来从Visual Studio内部轻松运行该工具。但是，有一件事情我必须警告您，如果您计划创建自己的结构，那么您可能会遇到问题。我知道，因为我曾经遇到过。 - randomperson25

Answer 4

这个列表里是否有对您有用的内容：https://stackoverflow.com/questions/1221413/what-tools-are-available-for-documenting-javascript？

- Phil C