jsdoc-best-practices

SKILL.md

This skill defines the JSDoc documentation standards for this project. The core principle is that documentation should explain "why", not just "what". Code already shows what it does—good documentation explains the reasoning, context, and non-obvious details that help developers understand and maintain the code.

This documentation adds no value—the function name already tells us it gets a user by ID.

The project enforces JSDoc through eslint-plugin-jsdoc with these rules:

Erzwingt JSDoc-Dokumentationsstandards für dieses TypeScript-Projekt. Diese Fähigkeit sollte beim Schreiben oder Überprüfen von TypeScript-Code verwendet werden, um eine ordnungsgemäße Dokumentation mit Dateipräambeln, Funktionsdokumenten, Schnittstellendokumenten und der entscheidenden Unterscheidung zwischen der Dokumentation von „Was“ und „Warum“ sicherzustellen. Nutzen Sie diese Fähigkeit, um die JSDoc ESLint-Regeln und etablierten Muster des Projekts zu verstehen. Quelle: codyswanngt/lisa.

Original anzeigen