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。