什么工具可用于记录jQuery插件？ [英] What tools are available for documenting jQuery plugins?

问题描述

最近我开始创建一些jQuery插件，我发现使用我发现的文档生成工具很难记录。我尝试过： JSDoc ， JSDoc-toolkit ， JGrouse 和基于Web的工具也。我最大的头痛是，我的插件被编码为一个大的匿名功能，我无法获取工具来识别我在做什么，或者忽略它，让我输入文档标签中的方法，对象等。

有没有其他工具可能有助于记录jQuery插件？

谢谢，
Sandro

解决方案

你有看过自然文件？它可能没有非常明确的支持JavaScript，但是它做得相当不错。当然，你可以欺骗它不要理解代码，但是如果你玩得很好，它可能是一个工具的地狱。

I've recently started creating some jQuery plugins and I'm finding it difficult to document them with the documentation generating tools that I've found. I've tried: JSDoc, JSDoc-toolkit, JGrouse and a web-based tool also. My biggest headache is that my plug-ins are coded as one big anonymous function, and I'm having trouble getting the tools to either recognize what I'm doing, or ignore it altogether and let me type in the documentation tags for the methods, objects, etc..

Are there any other tools that might help with documenting jQuery plugins?

Thanks, Sandro

解决方案

Have you had a look at Natural Docs? It might not have very much of explicit support for JavaScript, however it does a quite good job anyway. Of course you can trick it not to understand the code, but if you play nice with it, it can be a hell of a tool.

这篇关于什么工具可用于记录jQuery插件？的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！