用途:为 TypeScript 项目定义统一的 JSDoc 文档规范,在编写或审查代码时确保注释质量。核心原则是文档解释“为什么”,而不是复述代码已表达的“是什么”。
主要能力:通过 eslint-plugin-jsdoc 强制执行规则,包括 jsdoc/require-jsdoc 对函数声明、接口、类型别名和 PascalCase 箭头函数报错;require-param-description、require-returns-description、require-property-description 要求标签带说明;check-tag-names 允许自定义 @remarks 标签;关闭 JSDoc 中的类型要求,类型由 TypeScript 提供。
使用方式:文件顶部加 @file、@description、@module 前言;服务、方法、接口、类型分别按既定结构书写,用 @remarks 记录设计决策、约束与非显然行为;参数与返回值描述需给出取值范围、格式或边界条件。涉及装饰器时,正文用反引号包裹,@example 内用 @ 转义。
适用场景:本项目的 TypeScript 代码编写与代码审查。
限制:该技能面向此 TypeScript 项目,分类与具体 ESLint 配置以项目实际为准;未提供安装命令、平台范围与收费信息。