Programm zur automatisierten Dokumentenerstellung
Dokumentationsautomatisierung auf der Grundlage von code2prompt:
Wichtigste Schritte
- Bereiten Sie die Dokumentvorlage vor: im Fenster
templates/Erstellen Sie eine .hbs-Datei, die den Dokumentenrahmen unter dem - Metadaten hinzufügen: Verwendung in Vorlagen
{{file.content}}usw. variabler Einfügecode - Führen Sie den Konvertierungsbefehl aus:
code2prompt /project -t doc_template.hbs -o doc.md - Nachbearbeitung: Ersetzen von Kommentar-Tags im Code durch Skripte (z. B. Python's docstring)
Erweiterungsprogramm
- Versionszuordnung: Hinzufügen
--git-log-branchDemonstration der Evolutionsgeschichte - Diskrepanzmarke: Verwendung
--diffHervorhebung der letzten Änderungen - Ausgabe in mehreren FormatenMarkdown zu PDF/HTML über Pandoc
Typische Vorlagenstruktur
Es wird empfohlen, dass die Vorlage für die technische Dokumentation vier Abschnitte enthält: Projektübersicht ({{source_tree}}), Modulbeschreibungen ({{#each files}}), API-Referenz (automatische Extraktion von Funktionssignaturen) und Änderungsprotokoll ({{git_log}}).
Diese Antwort stammt aus dem Artikelcode2prompt: Konvertierung von Code-Bibliotheken in Big-Model verständliche Prompt-DateienDie
Darf nicht ohne Genehmigung vervielfältigt werden:KI-Produktivitätswerkzeuge " Wie kann ich die Erstellung einer detaillierten technischen Dokumentation für meine Codebasis automatisieren?
Deutsch 
简体中文 
English 
日本語 
Português do Brasil