将 jQuery 文档提升到新的水平

发布日期 作者

jQuery 1.0 巩固了框架的许多部分，但也引入了一些巧妙的结构性变化。

首先，框架现在通过 make 文件构建，因此任何人都可以从 Subversion 中检出 jQuery 并编译压缩或未压缩的 jquery.js 以供其网站使用。

其次，jQuery 现在包含 内置测试，make 文件可以构建测试套件，用户可以在其喜爱的浏览器中运行该套件，以确保最新的检入版本符合标准。目前还没有很多测试用例，但随着时间的推移这应该会改变（主要是因为添加它们非常容易）。

然而，对我来说最重要的还是内联文档的加入。从 jQuery 1.0 版本开始，框架文档 包含在源文件本身中，jQuery 的维护者 John Resig 编写了一个解析器，它将输出 文档的 XML 版本 作为 make 文件的一部分（一个简单的make docs将构建文档）。

Visual jQuery

在 1.0 版本推出之前，我将旧的 Visual jQuery 网站从基于 Rails 的解决方案（需要手动输入函数）转换为一个网站，该网站在函数提交到主干时动态加载文档。

对于技术水平较低的人来说，这意味着 Visual jQuery 现在几乎会在 jQuery 更新后立即更新。许多人发现可视化文档很方便易用，新版本努力保持这种易用性。

感谢 John，他的解析器输出的文件对像 Visual jQuery 这样的网站进行了非常好的优化。他确实将良好的文档作为优先事项。在我看来，jQuery 脱颖而出的主要原因之一是它强调提供可读的、良好的文档。我很高兴地说，jQuery 在这里做出了正确的选择。在接下来的几天里，John 将完全记录所有 jQuery 函数（还有一些尚未完成），可视化文档将完全代表 jQuery API。

Visual jQuery 杂志

The Magazine

有了这些，我还要宣布几件事。

  1. Visual jQuery 将在未来一两周内推出一个重大新功能。具体来说，用户将能够通过一个实时搜索框按名称和描述过滤函数。此功能将使查找特定函数变得更加容易。
  2. Visual jQuery 将推出一个每月在线杂志。它将以 PDF 格式发布，免费提供。第一期将包括对 John Resig 的采访，这是我们关于最新、最棒的 jQuery 插件系列文章中的第一篇，以及对 jQuery 对象（整个 jQuery 框架的核心）的直观了解。该杂志将在每个月的第三个星期三发布，因此该杂志的第一期（2006 年 9 月刊）将在 9 月 20 日发布。

与往常一样，请访问 VisualjQuery.com 获取最新的 Visual jQuery 文档以及有关该杂志的进一步公告。

关于“将 jQuery 文档提升到新的水平”的 8 个想法

  2. Pingback: 将 jQuery 文档提升到新的水平

  4. Nilesh 在 说：

    怎么样，这是我根据 Visual jQuery 制作的备忘单。

    下载（88kb）可打印的一页 PDF 备忘单，请访问以下链接

    http://www.define-web.com/jquery_cheat_sheet/jquery_cheat_sheet_080306_v1.pdf

    希望对您有所帮助，请注意，它是干净的，没有“由 XYZ 制作”，所以您可以随意使用它。

    待办事项
    我正在考虑制作第二页（背面），其中将包含一些额外有用的信息，例如 CSS 和 XPath 结合使用，以及一些基本示例。

    打印技巧
    将打印机设置设置为横向纸张布局。
    如果需要，请在 Adobe Acrobat 中设置“适合页面”选项。
    仅使用黑色墨水（不需要颜色）。

    它可能不是完美的备忘单，但可以完成工作！
    享受，
    Nilesh

  5. Essen 在 说：

    拥有经过精心编写且易于访问的文档确实是一件好事。这正是许多其他 JavaScript 库所缺少的。

    继续努力，干得漂亮！

  6. David 在 说：

    我几天前才开始使用 jQuery……可视化文档很棒！我期待阅读第一期 Visual jQuery 杂志……

  7. falcon 在 说：

    Nilesh,
    PDF 看起来很棒。但是，我非常希望有更多文档，例如函数的含义。显然这会增加页数，但它将非常有用。如果有直接的 Visual Query 到 PDF 版本，它将直接从我的打印机到我的显示器旁边的墙上！

    （我认为方法的描述、使用示例等对 jQuery 来说更加重要，因为它是一个相当新的 API，并且会有很多新手。）

    干得漂亮！

  8. Nilesh 在 说：

    这是 jQuery 备忘单的第二页。

    http://www.define-web.com/jquery_cheat_sheet/jquery_cheat_sheet_080306_v1_pg2.pdf

    它包含非函数信息，例如支持的选择器、基本/表达式/XPath/自定义、插件编写基础等。

    这 2 页备忘单的目标是将其用作参考，它的缺点是它不适合 jQuery 新手，我想你必须先了解一点 jQuery 才能真正使用它们。好吧，也许其他人会在某个时候推出面向新手的备忘单。

    一如既往，享受，
    Nilesh