Guide alla scrittura della documentazione Elixir con @moduledoc, @doc, @typedoc, doctests, riferimenti incrociati e metadati. Da utilizzare quando si aggiunge o si migliora la documentazione nei file .ex.
Installa rapidamente la skill AI elixir-writing-docs nel tuo ambiente di sviluppo tramite riga di comando
Fonte: existential-birds/beagle.
| Doctests: syntax, gotchas, when to use | references/doctests.md | | Cross-references and linking syntax | references/cross-references.md | | Admonitions, formatting, tabs | references/admonitions-and-formatting.md |
ExDoc and tools like mix docs extract the first paragraph of @moduledoc and @doc as a summary. Keep the opening line concise and self-contained.
For @opaque types, the @typedoc is especially important because callers cannot inspect the structure.
Guide alla scrittura della documentazione Elixir con @moduledoc, @doc, @typedoc, doctests, riferimenti incrociati e metadati. Da utilizzare quando si aggiunge o si migliora la documentazione nei file .ex. Fonte: existential-birds/beagle.
Campi e comandi stabili per citazioni AI/ricerca.
npx skills add https://github.com/existential-birds/beagle --skill elixir-writing-docsGuide alla scrittura della documentazione Elixir con @moduledoc, @doc, @typedoc, doctests, riferimenti incrociati e metadati. Da utilizzare quando si aggiunge o si migliora la documentazione nei file .ex. Fonte: existential-birds/beagle.
Apri il tuo terminale o strumento da riga di comando (Terminal, iTerm, Windows Terminal, ecc.) Copia ed esegui questo comando: npx skills add https://github.com/existential-birds/beagle --skill elixir-writing-docs Dopo l'installazione, la skill verrà configurata automaticamente nel tuo ambiente AI di coding e sarà pronta all'uso in Claude Code, Cursor o OpenClaw
https://github.com/existential-birds/beagle