Anleitungen zum Schreiben von Elixir-Dokumentation mit @moduledoc, @doc, @typedoc, doctests, Querverweisen und Metadaten. Wird zum Hinzufügen oder Verbessern der Dokumentation in .ex-Dateien verwendet.
Installieren Sie den KI-Skill elixir-writing-docs schnell in Ihrer Entwicklungsumgebung über die Kommandozeile
Quelle: 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.
Anleitungen zum Schreiben von Elixir-Dokumentation mit @moduledoc, @doc, @typedoc, doctests, Querverweisen und Metadaten. Wird zum Hinzufügen oder Verbessern der Dokumentation in .ex-Dateien verwendet. Quelle: existential-birds/beagle.
Stabile Felder und Befehle für KI/Such-Zitate.
npx skills add https://github.com/existential-birds/beagle --skill elixir-writing-docsAnleitungen zum Schreiben von Elixir-Dokumentation mit @moduledoc, @doc, @typedoc, doctests, Querverweisen und Metadaten. Wird zum Hinzufügen oder Verbessern der Dokumentation in .ex-Dateien verwendet. Quelle: existential-birds/beagle.
Öffnen Sie Ihr Terminal oder Kommandozeilen-Tool (Terminal, iTerm, Windows Terminal, etc.) Kopieren Sie diesen Befehl und führen Sie ihn aus: npx skills add https://github.com/existential-birds/beagle --skill elixir-writing-docs Nach der Installation wird der Skill automatisch in Ihrer KI-Programmierumgebung konfiguriert und ist bereit zur Verwendung in Claude Code, Cursor oder OpenClaw
https://github.com/existential-birds/beagle