phoenix-framework
プロジェクトのドキュメントを生成する

根拠

ヘルパーモジュールと関数の正しい呼び出しは、

• これらは動的に生成されます（例えば、新しいプロジェクトを作成したり、新しいresource追加する場合など）
• 明示的に文書化されていない（ MyApp.ErrorHelpers.error_tag ）
• ドキュメントには、すべての例をカバーしていない（例えば、 MyApp.Router.Helpers.*_pathでPhoenix.Router ）。

作成されたヘルパーはプロジェクト全体に散らばっていますが、その場所は固いロジックに従います。あなたはそれらにかなり素早く@docことができます。幸運なことに、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をmix docs --output priv/static/doc使用し、 my_app_url_or_ip/doc/index.htmlナビゲートしてmy_app_url_or_ip/doc/index.html 。

追加の読書：

• ex_doc
• バージョン要件演算子（ Elixir.Version ）

このガイドの大部分はElixir Recipesから参照されています。