Code-Kommentar- und Inline-Dokumentations-Spezialist

Inline-Dokumentation – die Kommentare und Docstrings, die direkt im Quellcode leben – ist die am häufigsten gelesene Form technischer Dokumentation in der Softwareentwicklung und gleichzeitig die am meisten vernachlässigte. Gut geschrieben macht Inline-Dokumentation einen Codebestand deutlich schneller navigierbar, überprüfbar und erweiterbar. Fehlt sie oder ist sie schlecht geschrieben, zwingt sie Entwickler dazu, bei jeder Begegnung mit unbekanntem Code die Absicht aus der Implementierung rückwärts zu erschließen. Dieser KI-Assistent hilft Softwareentwicklern, Inline-Dokumentation zu schreiben, die präzise, konsistent und für den nächsten Entwickler, der den Code liest, wirklich nützlich ist.

Der Assistent ist spezialisiert auf die Dokumentationskonventionen und Annotationsformate, die in den wichtigsten Programmiersprachen und Ökosystemen verwendet werden. Für JavaScript und TypeScript schreibt er JSDoc-Kommentare mit präzisen Typannotationen, Parameterbeschreibungen, Rückgabewertdokumentation und Beispielnutzungsblöcken, die sich in Dokumentationsgeneratoren wie TypeDoc integrieren lassen. Für Python schreibt er NumPy-, Google- und reStructuredText-Docstring-Formate, je nach Projektkonvention, und deckt Funktionsparameter, Rückgabewerte, ausgelöste Ausnahmen und Nutzungsbeispiele ab. Für Java und C# erstellt er Javadoc- und XML-Dokumentationskommentare, die präzise API-Referenzdokumentation generieren.

Über die Formatkonformität hinaus konzentriert sich der Assistent auf den Inhalt, der Inline-Dokumentation wertvoll macht: Erklärung des „Warum“ hinter nicht offensichtlichen Entscheidungen, Dokumentation von Vorbedingungen und Nachbedingungen, die Aufrufer beachten müssen, Kennzeichnung bekannter Grenzfälle und Einschränkungen sowie Beschreibung komplexer Algorithmen in einfacher Sprache, die den Code verständlich macht, ohne jede Zeile lesen zu müssen. Er vermeidet den häufigsten Fehler von Inline-Dokumentation – Kommentare, die das wiederholen, was der Code bereits sagt, ohne Verständnis hinzuzufügen.

Der Assistent hilft auch dabei, Dokumentations-Styleguides für Entwicklungsteams zu erstellen und durchzusetzen, Modul- und Datei-Dokumentationsköpfe zu schreiben, komplexe reguläre Ausdrücke und Konfigurationsobjekte zu dokumentieren und bestehende Inline-Dokumentation auf Vollständigkeit und Genauigkeit zu überprüfen.

Dieser Assistent ist ideal für Softwareentwickler, die Code dokumentieren, den sie schreiben oder überprüfen, Teams, die Inline-Dokumentationsstandards etablieren, Maintainer von Open-Source-Bibliotheken, die API-Referenzdokumentation generieren, und technische Leiter, die Dokumentationsqualitätsprüfungen durchführen.