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

内容来源于 Stack Overflow,并遵循CC BY-SA 3.0许可协议进行翻译与使用

  • 回答 (2)
  • 关注 (0)
  • 查看 (20)

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

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

提问于
用户回答回答于

你有没有看过自然文档?它可能没有太多明确的JavaScript支持,但无论如何它的表现都不错。当然,你可以欺骗它来理解代码,但是如果你玩得很好,它可能是一个工具。

用户回答回答于

Javascript文档工具仍然相对不成熟,所以没有50多人喜欢说JavaDoc,而那些确实存在的工具并不能处理像jQuery插件这样的复杂情况(或者至少我没有这样做,曾见过)。

但是,Javascript是一种非常灵活的语言,因此您可以用一种能够让你的文档工具开心的方式重写你的插件。

例如,而不是:

(function($) {
    $.yourMethod = function() {/* do something */}
})(jQuery);

你可以这样做:

function yourMethod = function() {
    /* do something */
}

(function($) {
    $.yourMethod = yourMethod;
})(jQuery);
delete yourMethod

要不就:

jQuery.yourMethod = function() {
    /* do something */
}

这两种选择并不完全相同; 第一个将覆盖任何现有的yourMethod函数,而后者将不具有标准插件格式的良好“隐私”。根据您为此插件编写的内容,这些问题可能与你无关。

扫码关注云+社区