合理

正確呼叫輔助模組和函式可能會令人生畏，因為

• 這些都是動態生成的（例如，在建立新專案或新增新專案時）
• 它們沒有明確記錄（例如，MyApp.ErrorHelpers.error_tag）
• 文件並未涵蓋所有示例（例如，MyApp.Router.Helpers.*_path 中的 MyApp.Router.Helpers.*_path）。

雖然建立的幫助程式分散在整個專案中，但它們的位置遵循一個堅實的邏輯。你可以非常快速地習慣它們，幸運的是，當你使用 Phoenix 生成專案時，程式碼隨附了 Elixir 的 @doc 和 @moduledoc 模組屬性的文件。

這些文件不僅限於幫助者，你也可以

• 看看你的專案按子模組/函式/巨集細分
• 新增自己的文件
• 查詢在專案名稱空間下生成的任何函式（例如，MyApp.Repo 包含來自 Ecto.Repo 的回撥函式實現）

生成文件

要從原始碼生成文件，請將 ex_doc 作為依賴項新增到 mix.exs 檔案中：

# config/mix.exs

def deps do
  [{:ex_doc, "~> 0.11", only: :dev}]
end

你可以在 Elixir @doc 和 @moduledoc 屬性中使用 Markdown。

然後，執行 mix deps.get 來獲取並編譯新模組，並使用 mix docs 生成專案文件。一個示例輸出是官方 Elixir Docs 。

要立即為他們服務，請使用 mix docs --output priv/static/doc 並導航至 my_app_url_or_ip/doc/index.html。

補充閱讀：

• ex_doc
• 版本要求運算子（Elixir.Version）

本指南的大部分內容均來自 Elixir Recipes 。