elixir-writing-docs

To write Elixir documentation, use `@moduledoc` for module overviews and `@doc` for functions. Ensure the first line is a concise summary, followed by structured content and clear examples to improve code clarity and developer onboarding.

Elixir documentation uses `@doc` and `@moduledoc` to generate API references, while code comments explain internal implementation details. Use `@doc` for public APIs and reserve comments for private code logic to ensure accurate, maintainable documentation.

Add metadata to Elixir documentation using `@doc since: "1.2.0"` or `@doc deprecated: "use new_function/1 instead"`. This annotates API version history and deprecation warnings directly in the generated ExDoc references for better developer experience.

Use `@doc false` in Elixir when you need to hide internal functions from generated ExDoc output. This keeps public API documentation clean while suppressing documentation generation for private or unstable APIs that should not be exposed.

Write Elixir doctests by embedding example code in `@doc` strings using the `iex>` prompt format. ExDoc extracts these examples and runs them as unit tests, ensuring your documentation remains accurate and validated during the build process.

Yes, Elixir supports documenting behavior modules and types. Use `@moduledoc` to explain callbacks and use `@typedoc` to provide descriptions for types, ensuring that ExDoc accurately renders the behavior contracts and type definitions in the API reference.