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:

強制執行此 TypeScript 項目的 JSDoc 文檔標準。在編寫或審查 TypeScript 代碼時應使用此技能，以確保正確記錄文件前導碼、函數文檔、接口文檔，以及記錄“什麼”與“為什麼”之間的關鍵區別。使用此技能來了解項目的 JSDoc ESLint 規則和既定模式。 來源：codyswanngt/lisa。

查看原文