在 VS Code 里敲 /** 再回车,看别人能弹出一整段带参数说明的注释,自己这边只有三个字符躺在原地。差别不在某个开关,而在文件的语言模式和语言服务。
JavaScript 里内置就能出
打开一个 .js 文件,在函数上方敲 /** 回车,编辑器会自动补出参数和返回值。敲斜杠之后弹出候选列表时,选带注释图标的那一项也行。右下角语言模式被设成纯文本,就什么都不会弹。
TypeScript、Java、C# 装好对应扩展后行为类似,扩展没装或者未激活,注释不会生成。
自定义模板用用户代码片段
命令面板输入 snippets,选首选项里的配置用户代码片段,新建一个全局片段文件。片段文件是 JSON,键和值都要用双引号包住,正文是一行一个字符串,换行靠行与行之间的逗号表示。
正文里可以放内置变量,插入时自动替换成当前值:
$CURRENT_YEAR-$CURRENT_MONTH-$CURRENT_DATE $CURRENT_HOUR:$CURRENT_MINUTE这行放第一条,第二条写创建者,第三条写文件说明。前缀设成 hd,之后在任意文件里敲 hd 再按 Tab,文件头就出来了。变量名拼错不会报错,只是原样输出,看到美元符号打头的字样没被替换,就是写错了。
占位符让填写更快
片段里能写占位符,插入后光标先停在第一个占位符上,按 Tab 跳到下一个。作者、日期这种固定内容放前面,需要手填的放后面,一路 Tab 就填完了。占位符的写法是美元符号加花括号包住编号和默认文字,编号相同的几处会一起改。
头部注释交给插件更省事
片段只能手动触发。想每次新建文件自动加注释,可以装带文件头功能的插件,装之前看更新时间和下载量,两年没维护的别碰。团队里最好把片段文件放进项目目录共享,别各写各的格式。
还有一处容易忽略,片段设置里有触发范围,设成某一种语言就只在那种语言里生效。在 vue 文件里敲不出来,先去检查范围那一项。
判断:个人项目用内置的 /** 就够,需要固定格式再配片段,自动加头不强求。注释写得对不对,比有没有模板更要紧。