10

jQuery 插件通常依赖于外部文件:jQuery 库、样式表 (CSS)、图像、其他插件等。使用(和编写)jQuery 插件的指导方针是什么?换句话说,所需的文件应该放在哪里:在主应用程序文件夹下(Img、Css、JS 或您使用的任何文件夹),在插件文件夹下(例如 Plugins/MyPlugin/Img、Plugins/MyPlugin/Css 等),或者是其他东西?

在项目中包含几个插件之后,我担心其他项目成员将很难确定需要哪些依赖项以及哪些文件应该放在哪里。

什么对你有用,什么没用?

4

1 回答 1

6

就个人而言,当我构建一个插件时,我会尽量减少它对其他资源的依赖以避免这个问题。有时你无法避免使用外部样式表,在这种情况下,我总是将它们与我的其他 CSS 文件放在一起,即使它们最初包含在与插件相同的文件夹中。这避免了在尝试决定哪些样式表应该放在哪里等时出现任何歧义。无论如何,您都必须手动包含它们。如果插件有任何依赖项,它们会放在 JS 文件夹中,以与其他插件类似的方式组织。在这种情况下,图像将与所有其他图像一起使用。

在构建插件时,您可以通过允许用户定义应用于某些对象的类来使其更加灵活,或者让用户定义插件将操作的结构。所有这些都可以在为其提供一组良好的默认值的同时完成,同时尽可能少地依赖外部资源。

至于是否为这些情况定义了最佳实践,我还没有找到。我只在 jQuery 网站上找到了插件创作指南:http: //docs.jquery.com/Plugins/Authoring

编辑:

至于澄清插件依赖组织:

当说你有 jquery.x.js 和 jquery.y.js。它们都依赖于 jquery.z.js。我一直将 jquery.z.js 与 jquery.x.js 和 jquery.y.js 放在同一个文件夹中。这避免了重复和与打破组织惯例相关的任何混淆。所以:

  • ./jquery.x.js
  • ./jquery.y.js
  • ./jquery.z.js

我通常这样组织我的文件夹:

  • ./js/jquery-xxxjs
  • ./js/plugins/jquery.x.js
  • ./js/plugins/jquery.y.js
  • ./js/plugins/jquery.z.js
于 2009-08-11T23:18:00.690 回答