Javascript 生成类似jQuery的API文档（不是源代码！）

我目前正在为jQuery编写插件。
现在我想知道如何为这个插件创建文档，因为我想有比直接编写HTML更好的方法

但是，我不想将文档放入源代码中，从而无法在调试时找到正确的行。因此，我正在寻找一种分离文档和源代码的方法

jQuery文档是如何生成的？在查看jQuery源代码时，我没有发现任何文档注释，这使我希望我能够使用与它们相同的系统。
他们使用的工具是否有文档记录

我在寻找答案时发现了以下XML文件，该答案似乎是在jQuery的“构建”过程中生成的。
我很乐意将我的文档写入一个类似的文件，并在上面运行一些工具来“美化”它，以便向用户显示它

如何为jQuery库创建文档（除了将其放入源代码中）？
有人知道jQuery团队使用的工具吗（或者至少知道文档最初的格式）

非常感谢

它似乎提供了中的文档（以及源代码中的文档）

原型团队用于记录原型的工具PDoc纯粹是通过注释工作的。（链接死了，所以我把它删除了。）这样你就可以拥有纯粹是插件PDoc注释的.js文件。2015年：据我所知，PDoc已经死了

---

我主张将注释放在源代码中-经典的维护问题是将它们分开-但是如果你不这么做，那就两个都是你的选择。

虽然我不同意在源代码中添加文档会让你在调试过程中更难找到正确的行，我很欣赏这样一种观点，即某些风格的文档在试图“进入代码”时可能会冗长且有点刺眼

我真的很喜欢下划线.js和backbone.js背后的人在他们的“注释源代码”文档中所采用的方法

例如，查看。该文档是基于在线评论生成的，如其所示。但请注意，这并不是一种繁重的多行文档风格，它更倾向于冗长而不是简洁。我知道您要求提供文件外文档，但我将此作为您问题的潜在解决方案提交给您

您可以使用生成此类文档，其中还包括指向Ruby、Python甚至shell脚本实现的链接。

您研究过吗

JsDoc工具包是一个应用程序， 用JavaScript编写，用于 自动生成 模板格式，多页HTML （或XML、JSON或任何其他 基于文本的）文档 注释JavaScript源代码

---

“但是，我不想将我的文档放入源代码中，从而使在调试时无法找到正确的行。”说什么？可能与@T.J重复约定的110%。在JS源代码中添加注释绝不会使“在调试时找到正确的行”变得更难嗯，我在文件中导航（没有包含文档）已经有问题了。我的插件如果远远没有完成，并有超过1000 LOC。在C#/Java中，我会将其拆分为多个文件，并将文档添加到源代码中。但是，这在JavaScript中是没有选项的。而且不仅仅是在调试时：在阅读代码时，文档注释只会分散对实际代码的注意力。@winSharp93:要在调试时找到正确的行“不可能”，还有很长的路要走。；-）任何像样的调试器（像现在大多数浏览器中内置的调试器）都几乎不可能不调出，只需以逐步模式突出显示当前行即可。仅仅1000 LOC，我看不出有什么问题，我发现编程编辑器的搜索功能完全可以胜任这项任务。同意这不是一个重复，顺便说一句，虽然它看起来（被接受的答案）可能有一个外部文件解决方案为您。不是直接我要找的，但肯定是方便的代码示例。谢谢-我不会用它来解决这个问题，但在另外一点上。“来自已注释JavaScript源代码的文档”谢谢-看起来我甚至可以不费吹灰之力切换到内联文档（或返回）。@winSharp93：是的，没错，在这两种情况下。很酷，真的。这是很久以前的事了，但是PDoc链接现在好像死了/指向了一个垃圾邮件发送者。@D_N:谢谢，哈哈-我没有时间陪戈达迪，但我不会叫他们垃圾邮件发送者。我会移除死链接。我一点也不惊讶这个项目失败了。@T.J.Crowder太糟糕了！我希望有不同的东西。