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.

원본 보기