vue项目注释需分层规范:文件头用korofileheader(禁用自动时间)、语义标记用better comments(按语言隔离)、函数级用vs code jsdoc命令+手动补全,避免document this/esdoc等插件因vue语法特性失效。

Vue 项目里注释乱、格式不统一、团队看不懂,不是靠插件“自动生成”能解决的——关键在规则分层:文件头用 koroFileHeader,语义标记用 Better Comments,函数级文档用 VS Code 内置 JSDoc 命令 + 手动校验,三者不能混用。
为什么 Document This / ESDoc 在 Vue 项目里基本失效
它们依赖函数签名做参数推导,但 Vue 组件的 setup 函数、defineProps 解构、组合式 API 的 ref/computed 声明,全都不符合传统 JS 函数结构。
-
defineProps({ id: Number, name: String })→ Document This 看不到参数名,生成空@param行 -
const { data } = useApi()→ ESDoc 无法识别useApi返回结构,@returns直接写{any} - 箭头函数写法的
computed(() => ...)或onMounted(() => {...})→ 两个插件均跳过,不触发注释生成 - Vue 单文件组件中
<script setup></script>没有显式函数名 → 插件找不到“被注释对象”,直接静默
koroFileHeader 配置必须关掉自动时间更新
它默认把 Date 和 LastEditTime 设为 “Do not edit”,但实际会偷偷覆盖你手动填的值,尤其在 Git 合并冲突后导致时间戳错乱。

