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。

查看原文