phoenix-framework
Genera documentazione di progetto

Fondamento logico

L'invocazione corretta dei moduli e delle funzioni di supporto può intimidire perché

• questi sono generati dinamicamente (ad esempio, quando si crea un nuovo progetto o si aggiunge una nuova resource )
• non sono documentati esplicitamente (es. MyApp.ErrorHelpers.error_tag )
• la documentazione non copre tutti gli esempi (ad es MyApp.Router.Helpers.*_path in Phoenix.Router ).

Sebbene gli helper creati siano sparsi per tutto il progetto ma la loro posizione segue una logica solida. Puoi @doc a loro abbastanza velocemente e fortunatamente, quando generi un progetto con Phoenix, il codice viene spedito con la documentazione tramite gli attributi del modulo @doc e @moduledoc di Elixir.

Questi documenti non sono limitati ai soli aiutanti, ma puoi anche farlo

• vedi il tuo progetto suddiviso per sottomoduli / funzioni / macro
• aggiungi la tua documentazione
• cercare tutte le funzioni che sono state generate sotto lo spazio dei nomi del tuo progetto (ad esempio, MyApp.Repo contiene implementazioni di funzioni di callback da Ecto.Repo )

Generare i documenti

Per generare documentazione dal tuo codice sorgente, aggiungi ex_doc come dipendenza nel tuo file mix.exs :

# config/mix.exs

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

Puoi utilizzare Markdown negli @doc Elixir @doc e @moduledoc .

Quindi, esegui mix deps.get per recuperare e compilare i nuovi moduli e generare la documentazione del progetto con i documenti di mix docs . Un esempio di output è il documento ufficiale di Elixir .

Per servirli immediatamente usa i mix docs --output priv/static/doc e vai a my_app_url_or_ip/doc/index.html .

Letture aggiuntive:

• ex_doc
• Operatori del requisito della versione ( Elixir.Version )

La maggior parte di questa guida fa riferimento alle Ricette con elisir .