phoenix-framework
Générer la documentation du projet

Raisonnement

L’invocation correcte des modules d’aide et des fonctions peut être intimidante, car

• ceux-ci sont générés dynamiquement (par exemple, lors de la création d'un nouveau projet ou de l'ajout d'une nouvelle resource )
• ils ne sont pas documentés explicitement (par exemple, MyApp.ErrorHelpers.error_tag )
• la documentation ne couvre pas tous les exemples (par exemple, MyApp.Router.Helpers.*_path dans Phoenix.Router ).

Bien que les assistants créés soient disséminés dans tout votre projet, leur emplacement suit une logique solide. Vous pouvez vous y habituer assez rapidement et heureusement, lorsque vous générez un projet avec Phoenix, le code est fourni avec la documentation via les attributs de module @doc et @moduledoc Elixir.

Ces documents ne sont pas limités aux assistants uniquement mais vous pouvez également

• voir votre projet décomposé par sous-modules / fonctions / macros
• ajoutez votre propre documentation
• rechercher les fonctions générées sous l'espace de noms de votre projet (par exemple, MyApp.Repo contient des implémentations de fonctions de rappel de Ecto.Repo )

Générer les documents

Pour générer la documentation à partir de votre code source, ajoutez ex_doc tant que dépendance dans votre fichier mix.exs :

# config/mix.exs

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

Vous pouvez utiliser Markdown dans les @doc Elixir @doc et @moduledoc .

Ensuite, lancez mix deps.get pour mix deps.get et compiler les nouveaux modules et générer la documentation du projet avec mix docs . Un exemple de sortie est le document officiel Elixir .

Pour les servir immédiatement, utilisez mix docs --output priv/static/doc et accédez à my_app_url_or_ip/doc/index.html .

Lecture supplémentaire:

• ex_doc
• Opérateurs d'exigence de version ( Elixir.Version )

L'essentiel de ce guide est référencé dans Elixir Recipes .