documentthis 参数解析失败时应改用具名函数、明确标注参数类型、避免匿名组件；chinese-comment 需手动触发且仅支持光标在函数名上；prettier 冲突需配置 jsdocseparation 或禁用 js 文件自动格式化；eslint 报错需及时补全描述或调松规则。
DocumentThis 生成注释时参数解析失败怎么办
DocumentThis 默认靠函数签名推断参数名和类型，但遇到箭头函数、解构参数、无类型 TS/JSX 或 any 类型时，常漏填或填错 @param。这不是插件坏了，是它没拿到足够信息。
实操建议：
- 把函数写成具名函数（而非
const fn = () => {}），DocumentThis 解析成功率明显提升 - TS 项目里给参数加明确类型，比如
(id: number, name: string)，别用(...args: any[]) - 如果用 React 函数组件，确保不是直接导出匿名函数，改用
function MyComponent({ props })形式 - 临时补救：生成后手动补全
@param，再选中整块注释按Ctrl+/注释掉，避免误提交空占位符
Chinese-comment 插件不生效的常见原因
Chinese-comment 声称“自动加中文注释”，但它其实只响应你手动触发的快捷键（默认 Alt+Z），不是保存就自动生成——这点容易误解。
实操建议：
- 确认快捷键是否被其他插件占用：打开
Ctrl+K Ctrl+S查看快捷键绑定，搜chinese-comment看对应命令是否启用 - 它只支持光标在函数名上时触发，放在函数体内部或空行无效
- 不支持类方法内的嵌套函数，也不处理箭头函数表达式
- 若想批量加注释，得配合多光标：选中多个函数名 →
Ctrl+Shift+L激活多光标 → 再按触发键
Prettier + DocumentThis 组合使用时格式错乱
DocumentThis 生成的 JSDoc 注释块默认带缩进空格，而 Prettier 的 prettier.tabWidth 和 prettier.useTabs 设置可能与之冲突，导致注释对齐崩坏、星号错位甚至被删掉部分行。
实操建议：
- 在
settings.json中加这条配置，让 Prettier 对 JSDoc “手下留情”："prettier.jsdocSeparation": true - 禁用保存时自动格式化 JSDoc 区域：设置
"editor.formatOnSave": true，但加上例外："[javascript]": { "editor.formatOnSave": false }（仅对 JS 文件关掉） - DocumentThis 生成后，先手动调整注释内换行和空格，再用
Shift+Alt+F全局格式化——别让 Prettier 抢在你编辑前介入
中文注释工具和 ESLint 冲突报错
ESLint 的 valid-jsdoc 或 jsdoc/require-param 规则会检查注释完整性，但 DocumentThis 和 Chinese-comment 生成的模板常含 {@link} 占位符或空描述，ESLint 就报 Missing JSDoc @param "xxx" description。
实操建议：
- 别等 ESLint 报错才补，生成注释后立刻填满每项
@param的描述，哪怕写“暂未定义”也比留空强 - 团队项目里，把 ESLint 的 JSDoc 规则调松一点：比如设
"jsdoc/require-param-description": "off"，只保留必填参数名检查 - VSCode 设置里关掉
eslint.autoFixOnSave，否则它可能自动删掉你刚填的中文描述
注释工具省的是敲星号和结构的时间，但语义准确性和上下文适配仍得人来把关——机器填不出“为什么这里要传 isStrict”，只能帮你把“@param isStrict”这行写出来。
