Document This 扩展要求光标紧贴函数/类声明关键字左侧,且语言模式正确(如javascript、typescript),不支持匿名函数、对象方法及箭头函数;多插件共存时可能触发冲突。

光标位置不对,Ctrl+Alt+D 就没反应
Document This 扩展只在光标紧贴函数/类/方法声明关键字左侧时才触发。比如 function 可以,但 function getData 或 getData 都不行。
- 常见错误现象:按了没反应,或生成注释错位到下一行
- 必须确保语言模式正确(右下角显示
javascript、typescript或typescriptreact) - 不支持匿名函数表达式,如
const fn = () => {};也不支持对象字面量里的方法obj: { method() {} } - TS 项目中若函数有多个重载签名,它只读第一个,可能漏参数——可关掉自动提取:
"jsdoc.autoAddTags": false
koroFileHeader 的 Ctrl+Alt+T 和语言模式强绑定
这个快捷键依赖当前文件的语言 ID,不是所有后缀都默认启用。比如 .py 文件要显式配置 Python 注释模板,否则按了只插入空块。
- 检查 settings.json 是否包含对应语言配置,例如 Python 需要有:
"fileheader.configObj": { "language": { "py": { "head": "'''", "middle": "@", "end": "'''" } } } - 如果右下角状态栏显示
Plain Text或JSON,Ctrl+Alt+T会静默失败 - PHP、Go 等非主流语言需手动补全
fileheader.configObj.language字段,否则注释符号(如//vs#)可能错乱
用 /** + 回车也能触发,但行为因扩展而异
VSCode 原生支持在函数名上方输入 /** 后回车,自动展开基础 JSDoc 框架;但参数提取能力弱,且不适用于 class 内部方法(除非装了 Document This 或类似插件)。
-
Doxygen Documentation Generator插件走这条路:输入/**→ 回车 → 自动生成带@param占位符的块,但不会识别 TS 类型 - Document This 在同一位置按
Ctrl+Alt+D会覆盖原生行为,且能读取 TS 参数类型 - 注意:如果已安装多个注释插件,它们的触发逻辑可能冲突——比如
koroFileHeader会劫持/**回车行为,导致 Document This 不再响应
类和构造函数注释得分开处理
Ctrl+Alt+D 对 class User 和 constructor 是两个独立动作,不能一次搞定。
- 光标放在
class行 → 生成类级注释(含User @class) - 光标移到
constructor行 → 再按一次 → 单独生成构造函数注释,参数自动列出(props) - getter/setter 方法需光标落在
get的name() get上,否则识别失败 - 类内部普通方法(如
getName())支持,但箭头函数写法getName = () => {}不支持
真正卡住人的地方,往往不是快捷键记不住,而是光标停在哪、语言模式对不对、插件之间有没有抢控制权——这三者任意一个出问题,Ctrl+Alt+D 或 Ctrl+Alt+T 都会“看起来失效”。











