哪些工具可用于记录 jQuery 插件?

What tools are available for documenting jQuery plugins?(哪些工具可用于记录 jQuery 插件?)
本文介绍了哪些工具可用于记录 jQuery 插件?的处理方法,对大家解决问题具有一定的参考价值,需要的朋友们下面随着跟版网的小编来一起学习吧!

问题描述

我最近开始创建一些 jQuery 插件,我发现很难使用我找到的文档生成工具来记录它们.我试过了:JSDoc, JSDoc-toolkit、JGrouse 和一个基于网络的工具还.我最头疼的是我的插件被编码为一个大的匿名函数,我无法让工具识别我在做什么,或者完全忽略它,让我输入方法的文档标签、对象等.

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..

还有其他工具可以帮助记录 jQuery 插件吗?

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

谢谢,桑德罗

推荐答案

你看过Natural Docs?它可能对 JavaScript 没有太多明确的支持,但无论如何它都做得很好.当然你可以欺骗它让它不理解代码,但如果你玩得很好,它可能是一个地狱般的工具.

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 插件?的文章就介绍到这了,希望我们推荐的答案对大家有所帮助,也希望大家多多支持跟版网!

本站部分内容来源互联网,如果有图片或者内容侵犯了您的权益,请联系我们,我们会在确认后第一时间进行删除!

相关文档推荐

在开发JS过程中,会经常遇到两个小数相运算的情况,但是运算结果却与预期不同,调试一下发现计算结果竟然有那么长一串尾巴。如下图所示: 产生原因: JavaScript对小数运算会先转成二进制,运算完毕再转回十进制,过程中会有丢失,不过不是所有的小数间运算会
append() 方法在被选元素的结尾(仍然在内部)插入指定内容。 语法: $(selector).append( content ) var creatPrintList = function(data){ var innerHtml = ""; for(var i =0;i data.length;i++){ innerHtml +="li class='contentLi'"; innerHtml +="a href
问题描述: 在javascript中引用js代码,然后导致反斜杠丢失,发现字符串中的所有\信息丢失。比如在js中引用input type=text onkeyup=value=value.replace(/[^\d]/g,) ,结果导致正则表达式中的\丢失。 问题原因: 该字符串含有\,javascript对字符串进行了转
Rails/Javascript: How to inject rails variables into (very) simple javascript(Rails/Javascript:如何将 rails 变量注入(非常)简单的 javascript)
CoffeeScript always returns in anonymous function(CoffeeScript 总是以匿名函数返回)
Ordinals in words javascript(javascript中的序数)