phoenix-framework
Wygeneruj dokumentację projektową

Racjonalne uzasadnienie

Prawidłowe wywołanie modułów pomocniczych i funkcji może być zastraszające, ponieważ

• są one generowane dynamicznie (np. podczas tworzenia nowego projektu lub dodawania nowego resource )
• nie są jawnie udokumentowane (np. MyApp.ErrorHelpers.error_tag )
• dokumentacja nie obejmuje wszystkich przykładów (np MyApp.Router.Helpers.*_path w Phoenix.Router ).

Chociaż utworzone pomocniki są rozrzucone po całym projekcie, ich lokalizacja jest zgodna z logiką. Możesz się do nich przyzwyczaić dość szybko i na szczęście, kiedy generujesz projekt w Phoenix, kod jest wysyłany wraz z dokumentacją poprzez atrybuty modułu Elixir @doc i @moduledoc .

Te dokumenty nie ograniczają się tylko do pomocników, ale możesz także

• zobacz swój projekt w podziale na podmoduły / funkcje / makra
• dodaj własną dokumentację
• wyszukaj wszystkie funkcje, które zostały wygenerowane w przestrzeni nazw twojego projektu (np. MyApp.Repo zawiera implementacje funkcji zwrotnej z Ecto.Repo )

Generowanie dokumentów

Aby wygenerować dokumentację z kodu źródłowego, dodaj ex_doc jako zależność do pliku mix.exs :

# config/mix.exs

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

Możesz użyć Markdown w @doc Elixir @doc i @moduledoc .

Następnie uruchom mix deps.get aby pobrać i skompilować nowe moduły oraz wygenerować dokumentację projektową za pomocą dokumentów mix docs . Przykładowym rezultatem są oficjalne dokumenty Elixir .

Aby je natychmiast obsłużyć, użyj mix docs --output priv/static/doc i przejdź do my_app_url_or_ip/doc/index.html .

Dodatkowe czytanie:

• ex_doc
• Operatory wymagań wersji ( Elixir.Version )

Większość tego przewodnika jest wymieniona w przepisach dotyczących eliksirów .