写注释真的好烦，每次dou得/**……*/的形式才有jsDoc的效果，真的不想浪费时间了于是写个vscode插件，添加一下jsDoc注释，提升点效率

将光标定位在指定的函数或变量上，然后按快捷键ALt+/或右击菜单选择Add Comment即可添加jsDoc注释

选择Zui基础的Typescript模板，建议使用yarn管理包，后面打包成vscode插件包的时候pnpm会因为文件找不到而失败。

Ru果想将菜单放在别的地方或者别的分组group，Ke以查kan官方文档contributes.menus的配置

说实话，我之前也纠结过为啥我的文章不被收录，害，咱就是说是不是内容太简单了或者是原创度不够？

有人说百度不收录新站，是不是因为新站权重不够啊？

不对不对，应该是内容质量的问题，你kan我这篇关于创建VSCode插件的文章，多有技术含量啊！

判断是否有光标，即focus聚焦在该代码编辑上了有时候打开文档但是没有聚焦光标

const doc = this.editor.document; const fileName = doc.fileName; //文件绝对路径 const code = doc.getText; //代码内容 this.sourceLines = this.getSourceLines; //是否有光标 if { return; } const pos = this.editor.selection.active.line; const item = this.sourceLines; //判断光标范围在文档代码有效范围内 if { return; } //光标具体所在代码的字符索引位置 const p = item + this.editor.selection.active.character;

Ru果是vue文件，要判断光标是否定位在vue的js/ts代码范围内，再获取其中的js/ts代码

if ) { let startIndex = code.indexOf; let endIndex = code.indexOf; if { return; } for { const c = code; if { startIndex = i + ; break; } } if { vscode.window.showInformationMessage; return; } //vue文件内js/ts代码 const script = code.substring; } ts/js解析代码成AST

我们常用Typescript库校验和编译代码，同时它也Neng将代码解析成AST，你懂的，这对咱们写插件来说超级有用！

const sourceFile = ts.createSourceFile; const currentNodes = this.findNode; 给不同节点添加注释

判断该节点是否Yi有jsDoc注释，Ru果有则不添加注释。

Ru果是单行注释或者非jsDoc的多行注释则转化为jsDoc注释

Ru果没有注释则直接添加

checkDocs => void) { //@ts-ignore if { //有jsDoc就不添加注释 } else { const comments: string = ; //头部注释 const leadingComments = ts.getLeadingCommentRanges; if { leadingComments.forEach => { const s = sourceFile.text.substring; comments.push); }); } //尾部注释 const tailingComments = ts.getTrailingCommentRanges; if { tailingComments.forEach => { const s = sourceFile.text.substring; comments.push); }); } if { //将旧的注释添加到jsDoc内 cb; } else { //添加新的注释 cb; } } }

Ru果Yi有注释则延用，Ru果没有注释则获取节点的名称作为注释内容，哈哈，这样挺方便的吧！

普通函数声明

//对应节点类型 FunctionDeclarationfunction sum: number { return a + b;}

方法定义

const obj = {//对应节点类型 MethodDeclaration fun { console.log; }};class Person {//对应节点类型 ConstructorDeclaration constructor { console.log; } //对应节点类型 MethodDeclaration dd { console.log; }} 箭头函数与匿名函数

箭头函数

//对应的AST结构 VariableDeclaration.initializer=ArrowFunctionconst myFun = : number => { return a + b;};

给变量赋值匿名函数

//对应的AST结构 VariableDeclaration.initializer=FunctionExpressionconst myFun = function : number { return a + b;}; 其他节点添加注释

addComment { if { for { const stmt = nodes; // if ... }