XQuery/命名规范

维基教科书作者指南

我们的目标是让许多人能够贡献示例，但同时也为我们的读者提供一致的用户体验。鉴于此，我们希望所有作者都使用以下一些标准。

本书重点关注通过示例学习 XQuery 的某些方面。我们希望拥有大量小型示例 XQuery 程序的集合。每个程序都应该包含最少的代码来演示 XQuery 的某些方面。尽管大多数用户使用 eXist，但我们希望这些示例可以用于 MarkLogic、BaseX 和其他 XQuery 系统。

确保使用 source 标签包围您的代码。如果是 XML 代码，请使用 lang="xml" 属性。

<syntaxhighlight lang="xml">
  ...xml code here...
</syntaxhighlight>

If it is XQuery code use the lang="xquery" attribute.

<syntaxhighlight lang="xquery">
  ...xml code here...
</syntaxhighlight>

尝试使示例尽可能简单，以演示示例的核心概念。

xquery version "1.0";
let $message := 'Hello World!'
return
<results>
   <message>{$message}</message>
</results>

每个 XQuery 文件都应该以 xquery 和版本号开头。

xquery version "1.0";

复杂的 XQuery 应该使用 XQuery 注释进行注释

xquery version "1.0";

(: This is a comment :)

请使用三个空格字符缩进您的 XQuery 和 XML 示例。不要使用制表符。我们使用三个字符，因为我们使用这些书籍的 PDF 输出，并且打印页面宽度有限。

请不要超过每行 70 个字符。这有助于格式化本维基教科书的印刷版本。

对于存储在数据库中的 XQuery 脚本，请使用 .xq 后缀。

如果您正在运行必须与三字母 Microsoft DOS 文件名扩展名兼容的系统，请使用 .xql 文件后缀。

对于 XQuery 模块，请使用后缀 .xqm。

对于每个具有单元测试的模块，请使用后缀 -test.xq。