Generiert automatisch umfassende Inline-Kommentare und Dokumentationsstrings für Ihre Codebasis, um die Wartbarkeit zu verbessern.
Installieren & Herunterladen
1. ClawHub CLI
Der schnellste Weg, einen Skill direkt aus der Registry zu installieren.
npx clawhub@latest install code-comments
2. Manuelle Installation
Kopiere den Skill-Ordner an einen dieser Orte
~/.openclaw/skills/ <project>/skills/ Priorität: Workspace > Lokal > Integriert (Bundled)
3. Prompt-Installation
Kopiere diesen Prompt in OpenClaw, um ihn automatisch zu installieren.
Hilf mir, code-comments über Clawhub zu installieren. Falls Clawhub nicht installiert ist, installiere es bitte zuerst (npm i -g clawhub).
Lieber herunterladen?
Hole dir die rohen Skill-Dateien in einem ZIP-Archiv.
Was ist Code-Kommentar-Generator?
Der Code-Kommentar-Generator ist ein robustes Dienstprogramm, das entwickelt wurde, um den Dokumentationsprozess für Entwickler zu rationalisieren. Durch die Analyse der Strukturlogik Ihres Quellcodes erstellt dieser Skill automatisch kontextrelevante Kommentare, Docstrings und Header-Dokumentationen. Er ist ein wesentlicher Bestandteil des Openclaw Skills-Ökosystems und hilft Teams dabei, hohe Standards bei der Code-Klarheit einzuhalten, ohne den manuellen Aufwand, der normalerweise mit dem Schreiben technischer Dokumentation verbunden ist.
Dieser Skill unterstützt eine Vielzahl von Programmiersprachen und Dokumentationsstilen und ist somit ein vielseitiges Asset für jeden Entwicklungsworkflow. Egal, ob Sie eine veraltete Codebasis bereinigen oder eine neue Funktion für die Überprüfung vorbereiten: Die Integration dieses Tools aus der Openclaw Skills-Sammlung stellt sicher, dass Ihr Code zugänglich und professionell bleibt.
Code-Kommentar-Generator Anwendungsfälle
- Standardisierung von Docstrings in großen, mehrsprachigen Repositories.
- Schnelle Dokumentation komplexer Algorithmen zur Unterstützung der Teamzusammenarbeit.
- Vorbereitung von Quellcode für die Generierung öffentlicher API-Dokumentationen.
- Verbesserung von Legacy-Codebasen, denen klare beschreibende Kommentare fehlen.
So funktioniert Code-Kommentar-Generator
- Der Agent parst die Zieldatei, um Funktionen, Klassen und Logikblöcke zu identifizieren.
- Er bewertet den Zweck von Parametern, Rückgabetypen und Variablenzuweisungen.
- Der Skill generiert sprachenspezifische Dokumentationen (wie JSDoc, Python Docstrings oder Doxygen).
- Die Kommentare werden in die Quelldatei eingefügt oder als Diff zur Genehmigung durch den Entwickler über die Openclaw Skills-Schnittstelle präsentiert.
Code-Kommentar-Generator Einrichtung
Um diesen Skill in Ihre lokale Umgebung zu integrieren, verwenden Sie den folgenden Befehl:
openclaw install code-comments-generator
Nach der Installation können Sie Ihre Dokumentationseinstellungen in der globalen Konfigurationsdatei anpassen, um sicherzustellen, dass alle Openclaw Skills mit dem Styleguide Ihres Teams übereinstimmen.
Code-Kommentar-Generator Datenschema & Taxonomie
Der Skill organisiert seine Analyse und Ausgabe nach dem folgenden Schema:
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
source_file |
String | Der Pfad zur aktuell verarbeiteten Datei. |
doc_style |
String | Das verwendete Format (z. B. Javadoc, Google, NumPy). |
coverage_report |
Object | Statistiken über den Prozentsatz des erfolgreich dokumentierten Codes. |
agent_version |
String | Die spezifische Version der verwendeten Openclaw Skills-Engine. |
Code-Kommentar-Generator Erweiterte Funktionen
- Mehrsprachige Unterstützung für Python, JavaScript, TypeScript, Go und C++.
- Benutzerdefinierte Vorlagen-Overrides zur Anpassung an einzigartige Unternehmens-Dokumentationsstandards.
- Batch-Verarbeitungsfunktionen zur Bearbeitung ganzer Projektverzeichnisse in einem Durchlauf.
- Integrations-Hooks für CI/CD-Pipelines, um sicherzustellen, dass neuer Code die Dokumentationsschwellen innerhalb des Openclaw Skills-Frameworks erfüllt.
SKILL.md
Laden
Verwandte Openclaw-Skills
Copywriting für Bundle-Angebote
Ein leistungsstarkes KI-Tool zur Erstellung überzeugender Marketingtexte für Mengenrabatte und Bundle-Angebote auf E-Commerce-Plattformen.
Teamo Lite
Teamo Lite ist ein Hochgeschwindigkeits-KI-Agent, der für effiziente Aufgabenplanung, Echtzeit-Informationsbeschaffung und automatisierte Content-Erstellung entwickelt wurde.
Teamo Lite Offline
Teamo Lite Offline ist ein leistungsoptimierter KI-Agent, der für die schnelle Informationsbeschaffung, intelligente Forschung und optimierte Aufgabenplanung entwickelt wurde.
Teamo Decision
Ein Elite-KI-Orchestrierungsagent, der McKinsey-Methoden zur Problemlösung anwendet, um komplexe Aufgaben zu zerlegen, zu planen und an spezialisierte Sub-Agenten zu delegieren.
Kundenservice-Skripte
Eine KI-gestützte Funktion zur sofortigen Erstellung professioneller, kontextrelevanter Kundenservice-Antwortskripte.
E-Mail-Auto-Antwort-Generator
Ein KI-gestütztes Dienstprogramm zur Erstellung kontextbezogener und professioneller E-Mail-Antworten basierend auf spezifischen Kommunikationsszenarien.
Hervorgehoben*
