我目前正在为jQuery编写一个插件.

现在我想知道我应该如何创建这个插件的文档,因为我猜有比直接编写
HTML更好的方法.

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

如何生成jQuery文档？在查看jQuery源代码时,我没有找到任何文档注释,这使我希望我可以使用与他们相同的系统.
他们使用的工具是否以某种方式记录？

我在寻找答案http://api.jquery.com/api/时找到了以下XML文件,这个答案似乎是在jQuery的“build”-process中生成的.
我很乐意将我的文档写入一个类似的文件,并在其上运行一些工具来“美化”它以便将其显示给用户.

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

提前谢谢了！

最佳答案 看起来
NaturalDocs提供了
external files(以及源代码)中的文档.

Prototype团队用于记录Prototype PDoc的工具纯粹来自于注释. (链接已经死了,所以我删除了它.)所以你可以拥有.js文件纯粹是你的插件的PDoc注释. 2015年：据我所知,PDoc已经死了.

我主张在源代码中添加注释 – 经典维护问题将它们分开 – 但是如果你没有这样做,那么公平的’nuff,这两者似乎都是你的选择.