Die stillen Bugs – Dokumentation, die lügt
Docs, die altes Verhalten beschreiben – die gefährlichste Art von Dokumentation
Öffentliche Funktionen und Endpunkte ohne ordnungsgemäße Dokumentation
Kommentare, die etwas anderes sagen als der Code tut – schlimmer als keine Kommentare
API-Docs, die nicht mit tatsächlichen Endpunkten übereinstimmen – #1 Ursache für Integrationsfehler
Storybook- und Komponenten-Dokumentation, die Props-Änderungen nicht widerspiegelt
TypeDoc/JSDoc-Typen, die über tatsächliche Interfaces und Signaturen lügen
Jeder Ort, an dem Docs und Code auseinanderdriften können
Funktions- und Methoden-Dokumentation
Projekt- und Paket-Übersichten
Code-Erklärungen und TODOs
Endpunkt-Beschreibungen und Beispiele
Interface- und Typ-Kommentare
Genauigkeit der Versionshistorie
Wie technische Schulden sammeln sich Dokumentations-Schulden still an. Wir geben Ihrer Codebasis einen Dokumentations-Gesundheits-Score — eine einzelne Zahl, die zeigt, wie weit Ihre Docs von der Realität abgedriftet sind.
README.md
Letzte Aktualisierung vor 45 Tagen, Code 12x geändert
src/api/
3 Endpunkte undokumentiert
CHANGELOG.md
Fehlende Einträge für v2.3.0, v2.3.1
src/utils/
8 exportierte Funktionen ohne JSDoc
Nicht nur generische Doc-Prüfungen — wir verstehen die Dokumentationsmuster Ihres Frameworks
Für Funktion processPayment(amount, currency, options):
/**
* Verarbeitet eine Zahlungstransaktion
* @param amount - Zahlungsbetrag in Cents (Integer)
* @param currency - ISO 4217 Währungscode
* @param options - Verarbeitungsoptionen
* @param options.idempotencyKey - Eindeutiger Schlüssel
* @param options.metadata - Benutzerdefinierte Key-Value-Paare
* @returns Promise<PaymentResult>
* @throws PaymentError bei Ablehnung
*/Wenn wir fehlende oder veraltete Dokumentation finden, melden wir es nicht nur — wir generieren die Korrektur. KI analysiert Ihre Funktionssignaturen, Rückgabetypen und Nutzungsmuster, um genaue Dokumentation vorzuschlagen.
Erstellt Dokumentation aus Funktionssignaturen und Typen
Aktualisiert veraltete Dokumentation, um mit aktuellem Code übereinzustimmen
Echte Beispiele von Docs, die aktualisiert werden mussten
/**
* Ruft Benutzer nach ID ab
* @param id - Benutzer-ID
* @param includeDeleted - Soft-gelöschte Benutzer einschließen
*/
async function getUser(id: string, options?: GetUserOptions) {
// includeDeleted wurde vor 3 Monaten in options-Objekt verschoben
// aber JSDoc zeigt immer noch alte Signatur
}JSDoc zeigt alte Signatur mit Positions-Parameter
/**
* Ruft Benutzer nach ID ab
* @param id - Benutzer-ID
* @param options - Abfrageoptionen
* @param options.includeDeleted - Soft-gelöschte Benutzer einschließen
* @param options.fields - Auszuwählende Felder
*/
async function getUser(id: string, options?: GetUserOptions) {
// Dokumentation entspricht tatsächlicher Signatur
}Aktualisierung auf aktuelles Options-Objekt-Muster
// 3x mit exponentiellem Backoff wiederholen
async function fetchWithRetry(url: string) {
const MAX_RETRIES = 5 // Geändert von 3
const response = await fetch(url)
// Tatsächlich keine Retry-Logik mehr implementiert
return response
}Kommentar beschreibt Retry-Logik, die nicht existiert
// Einfacher Fetch-Wrapper, keine Retry-Logik
// Für Wiederholungen, verwenden Sie fetchWithRetry aus @/lib/http
async function simpleFetch(url: string) {
const response = await fetch(url)
return response
}Kommentar spiegelt tatsächliches Verhalten wider
## Installation
```bash
npm install
npm run setup # Dieses Skript wurde entfernt
```
## Umgebungsvariablen
- `DATABASE_URL` - PostgreSQL-Verbindung
- `REDIS_URL` - Redis-Verbindung # Wir sind auf In-Memory-Cache umgestiegen
README verweist auf entferntes Skript und alte Redis-Konfiguration
## Installation
```bash
npm install
```
## Umgebungsvariablen
- `DATABASE_URL` - PostgreSQL-Verbindungsstring
- `CACHE_TTL` - Cache-Dauer in Sekunden (Standard: 3600)
Dokumentation spiegelt aktuellen Setup-Prozess wider
Dokumentations-Reviewer überprüft nicht nur, ob Docs existieren – er verifiziert, dass sie mit dem übereinstimmen, was der Code tatsächlich tut. Wenn Sie eine Funktionssignatur ändern, markiert er das JSDoc.
Vergleicht, was Docs sagen vs. was Code tut
Bemerkt, wenn Code-Änderungen nahegelegene Docs ungültig machen
Liefert spezifischen Text zur Korrektur der Dokumentation
Code & Docs vergleichen
Prüft, ob die Dokumentation mit der tatsächlichen Implementierung übereinstimmt
Änderungen erkennen
Identifiziert, wenn Code-Änderungen bestehende Docs ungültig machen
Unstimmigkeiten markieren
Meldet Dokumentation, die Entwickler in die Irre führen könnte
Updates vorschlagen
Liefert spezifischen Text, um Docs auf den neuesten Stand zu bringen
Schlechte Docs kosten mehr als keine Docs
Genaue Docs bedeuten, dass Entwickler keine Stunden mit falschen Fährten verschwenden
Neue Entwickler können dem vertrauen, was sie lesen, anstatt zu raten
Nutzer können sich auf Ihre API-Docs verlassen, ohne Trial-and-Error
Jede Code-Änderung ist eine Chance für Docs, abzudriften.
Dokumentations-Reviewer erkennt es jedes Mal.
Diese Probleme rutschen jeden Tag durch — bis jetzt
der README-Dateien sind innerhalb von 6 Monaten veraltet
der JSDoc-Kommentare stimmen nicht mit Funktionssignaturen überein
durchschnittlich verschwendete Zeit beim Debugging wegen falscher Docs
der API-Docs fehlt mindestens ein erforderliches Feld
Lassen Sie Dokumentations-Reviewer Drift erkennen, bevor es irreführt. 14 Tage kostenlos, keine Kreditkarte erforderlich.