Codekommentare für AI-Lesbarkeit optimieren
Schreibe präzise und strukturierte Kommentare die von AI-Modellen besser interpretiert werden können. Dies verbessert die Code-Generierung durch AI-Tools.
Originalvideo ansehen: Tragic mistake... Anthropic leaks Claude’s source code3 Schritte
1
Verwende strukturierte JSDoc Format
Dokumentiere Funktionen mit JSDoc um AI-Modelle zu helfen
/**
* Konvertiert Benutzer-Input zu sicheren Datenbankabfragen
* @param {string} userInput - Die Eingabe vom Benutzer
* @param {Object} options - Optionale Parameter
* @param {boolean} options.strict - Strikter Validierungsmodus
* @returns {string} Bereinigte und sichere Abfrage
* @throws {Error} Bei ungültiger Eingabe
* @example
* const query = sanitizeQuery('SELECT * FROM users', { strict: true });
*/
function sanitizeQuery(userInput, options = {}) {
// Implementation
}Tipp: Nutze @param, @returns und @throws um die Funktion vollständig zu dokumentieren
Warnung: JSDoc-Kommentare sollten kurz und präzise sein, nicht zu lang
2
Schreibe klare Inline-Kommentare für komplexe Logik
Erkläre das 'Warum', nicht das 'Was' in Kommentaren
// FALSCH - Erklärt das Offensichtliche
let x = 5; // Set x to 5
// RICHTIG - Erklärt das Warum
// Verwende 5 Sekunden Timeout um Race Conditions zu vermeiden
const DEBOUNCE_DELAY = 5;
// Komplexe Logik erklären
// Nutze exponentielles Backoff um Server nicht zu überlasten
const backoffDelay = Math.min(300 * Math.pow(2, retryCount), 30000);Tipp: Fokussiere auf Business-Logik, nicht auf Syntax
Warnung: Zu viele Kommentare können Code schwerer lesbar machen
3
Strukturiere Dateien mit Header-Kommentaren
Gib einen Überblick über die Datei am Anfang
/**
* User Authentication Module
*
* Verantwortlich für:
* - Login und Logout Funktionalität
* - Token-Generierung und Validierung
* - Password-Hashing und Sicherheit
*
* Dependencies: bcrypt, jsonwebtoken
* @author TeamName
* @version 1.0.0
*/Tipp: Gebe Kontext über Purpose, Dependencies und Ownership
Warnung: Halte Header-Kommentare aktuell