Was macht create-oo-component-dokumentation?
Erstellen Sie umfassende, standardisierte Dokumentation für objektorientierte Komponenten gemäß Best Practices und Architekturdokumentationsstandards der Industrie.
Übersicht
Diese Fähigkeit generiert automatisch strukturierte Dokumentation für objektorientierte Komponenten. Sie analysiert den Quellcode, erkennt Vererbungshierarchien, Schnittstellenverträge und Abhängigkeiten und produziert eine menschenlesbare, architekturell korrekte Dokumentation.
Verwendung
# Beispielaufruf (CLI)
create-oo-component-documentation --source ./src/components --output ./docs
Funktionen
- Zweck und Verantwortlichkeiten: Beschreibt die Verantwortlichkeit jeder Komponente im Systemkontext.
- Schnittstellen: Dokumentiert öffentliche Methoden, Eigenschaften und Events mit Parametern, Rückgabetypen und Ausnahmen.
- Abhängigkeiten: Listet benötigte und bereitgestellte Schnittstellen, externe Bibliotheken und Konfigurationen auf.
- Verhalten: Beschreibt Zustandsautomaten, Invarianten, Vor- und Nachbedingungen sowie Lebenszyklusregeln.
- Beispiele: Enthält Codebeispiele für typische Verwendungsszenarien.
Unterstützte Plattformen
- Claude Code
- Cursor
- Codex
- Andere KI-Assistenten mit Markdown-Ausgabe
Beispielausgabe
# Klasse: OrderProcessor
**Verantwortlichkeit**: Verarbeitet Bestellungen, führt Validierungen durch und aktualisiert den Bestellstatus.
## Öffentliche Schnittstelle
- `processOrder(orderId: string): Promise<OrderStatus>` – Validiert und verarbeitet eine Bestellung.
- `cancelOrder(orderId: string): Promise<void>` – Bricht eine Bestellung ab, falls sie noch nicht versandt wurde.
## Abhängigkeiten
- **Verwendet**: `InventoryService`, `PaymentGateway`, `NotificationService`
- **Verwendet von**: `OrderController`, `WebhookHandler`
## Verhalten
- **Zustände**: `Pending → Validated → Processing → Completed | Failed`
- **Invarianten**: Eine Bestellung kann nur einmal verarbeitet werden.
Einschränkungen
- Die Qualität der generierten Dokumentation hängt von der Struktur und Klarheit des Quellcodes ab.
- Dokumentiert keine Implementierungsdetails, es sei denn, diese sind für die Nutzung der Komponente relevant.
Lizenz
MIT