phoenix-framework
Genereer projectdocumentatie

motivering

De juiste aanroep van hulpmodules en functies kan intimiderend zijn omdat

• deze worden dynamisch gegenereerd (bijvoorbeeld bij het maken van een nieuw project of het toevoegen van een nieuwe resource )
• ze zijn niet expliciet gedocumenteerd (bijvoorbeeld MyApp.ErrorHelpers.error_tag )
• de documentatie omvat niet alle voorbeelden (bijv. MyApp.Router.Helpers.*_path in Phoenix.Router ).

Hoewel de gecreëerde helpers over uw project verspreid zijn, maar hun locatie volgt een solide logica. Je kunt er vrij snel aan wennen en gelukkig, wanneer je een project met Phoenix genereert, wordt de code met documentatie verzonden via Elixir's @doc en @moduledoc module-attributen.

Deze documenten zijn niet beperkt tot alleen helpers, maar u kunt ook

• zie uw project uitgesplitst naar submodules / functies / macro's
• voeg uw eigen documentatie toe
• zoek alle functies die zijn gegenereerd onder de naamruimte van uw project (bijvoorbeeld, MyApp.Repo bevat callback-functie-implementaties van Ecto.Repo )

Documenten genereren

Om documentatie uit uw broncode te genereren, voegt u ex_doc als afhankelijkheid toe aan uw mix.exs bestand:

# config/mix.exs

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

Je kunt Markdown gebruiken binnen Elixir @doc en @moduledoc attributen.

Vervolgens voert mix deps.get te halen en samen te stellen van de nieuwe modules en het project documentatie te genereren mix docs . Een voorbeelduitvoer is de officiële Elixir Docs .

Om ze onmiddellijk te bedienen, gebruikt u mix docs --output priv/static/doc en navigeert u naar my_app_url_or_ip/doc/index.html .

Extra lezen:

• ex_doc
• Versie- Elixir.Version ( Elixir.Version )

Het grootste deel van deze gids wordt genoemd uit Elixir Recepten .