<分区>
我目前正在为 jQuery 编写一个插件。
现在我想知道我应该如何为这个插件创建文档，因为我想有比直接编写 HTML 更好的方法。
但是，我不想将我的文档放入源代码中，从而无法在调试时找到正确的行。因此，我正在寻找一种方法来分离文档和源代码。
jQuery 文档是如何生成的？在查看 jQuery 源代码时，我没有找到任何文档注释，这让我希望我可以使用与他们相同的系统。
他们使用的工具是否以某种方式记录在案？
我在寻找答案时发现了以下 XML 文件 http://api.jquery.com/api/这似乎是在 jQuery 的“构建”过程中的某个时间生成的。
我很乐意将我的文档写入一个类似的文件，并在其上运行一些工具来“美化”它以便将其显示给用户。
如何为 jQuery 库创建文档(除了将其放入源代码中)？
有谁知道 jQuery 团队使用的工具(或者至少知道文档最初的格式)？
非常感谢!
最佳答案
看起来像NaturalDocs在 external files 中提供文档(以及源代码中)。
Prototype 团队用于记录 Prototype 的工具 PDoc 完全基于评论工作。 (链接已失效，所以我将其删除。)因此您可以拥有纯粹是插件的 PDoc 注释的 .js 文件。 2015:据我所知可以看出，PDoc 已经死了。
我提倡在源代码中添加注释——将它们分开的经典维护问题——但如果你决定不这样做，公平地说，这两个似乎都是给你的选择。
关于javascript - 像 API 文档一样生成 jQuery(不是来自源代码!)，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/5792409/
相关文章：
javascript - 使用 Javascript 或 JQuery 插入响应式 CSS 规则
javascript - html 和 javascript 中的复选框属性
javascript - 如何使用来自 rest api json 的 jQuery Datatable 插件？
go - 如何使用 godoc 与 go 模块一起提供文档？
javascript - .setAttribute ("disabled"，假)；将可编辑属性更改为 false
javascript - 从服务器端向客户端发送 jwt token 的正确方法是什么？