phoenix-framework
Generar documentación del proyecto.

Razón fundamental

La correcta invocación de módulos de ayuda y funciones puede ser intimidante porque

• estos se generan dinámicamente (por ejemplo, cuando se crea un nuevo proyecto o se agrega un nuevo resource )
• no están documentados explícitamente (por ejemplo, MyApp.ErrorHelpers.error_tag )
• la documentación no cubre todos los ejemplos (por ejemplo, MyApp.Router.Helpers.*_path en Phoenix.Router ).

Aunque los ayudantes creados están dispersos por todo el proyecto, su ubicación sigue una lógica sólida. Puede acostumbrarse a ellos bastante rápido y, afortunadamente, cuando genera un proyecto con Phoenix, el código se envía con la documentación a través de los atributos de los módulos @doc y @moduledoc Elixir.

Estos documentos no están limitados solo a ayudantes, sino que también puede

• vea su proyecto desglosado por submódulos / funciones / macros
• añade tu propia documentación
• busque las funciones que se generaron bajo el espacio de nombres de su proyecto (por ejemplo, MyApp.Repo contiene implementaciones de función de devolución de llamada de Ecto.Repo )

Generando los documentos

Para generar documentación a partir de su código fuente, agregue ex_doc como dependencia en su archivo mix.exs :

# config/mix.exs

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

Puede utilizar Markdown dentro de los @doc Elixir @doc y @moduledoc .

Luego, ejecute mix deps.get para obtener y compilar los nuevos módulos y generar la documentación del proyecto con documentos mix docs . Un ejemplo de salida es el oficial Elixir Docs .

Para servirlos de inmediato, utilice mix docs --output priv/static/doc y navegue hasta my_app_url_or_ip/doc/index.html .

Lectura adicional:

• ex_doc
• Operadores de requisitos de versión ( Elixir.Version )

El grueso de esta guía está referenciado en Recetas de Elixir .