jsdoc 自动使用描述字段

Har*_*rry 5 javascript jsdoc visual-studio-code

我有一个这样的对象:

resource.foo= {
  name: "Foo",
  desc: "Some description"
}
Run Code Online (Sandbox Code Playgroud)

我发现自己在写:

/**
 * Some description
 */
resource.foo= {
  name: "Foo",
  desc: "Some description"
}
Run Code Online (Sandbox Code Playgroud)

无论如何,要自动获取 desc 字段而无需复制和粘贴吗?

Mar*_*ark 3

这是另一种方法,使用键合。使用我编写的扩展Find and Transform,将其放入您的keybindings.json

{
  "key": "alt+d",                   // whatever keybinding you want
  "command": "findInCurrentFile",
  "args": {
    "preCommands": [
      "editor.action.jumpToBracket",
      "editor.action.selectToBracket",
      "editor.action.clipboardCopyAction",
      "editor.action.insertLineBefore"
    ],
    "replace": [
      "$${",
        "return `/**\n * ` + ${CLIPBOARD}.desc  + `\n */`",
      "}$$",
    ],
    "postCommands": "cancelSelection"
  }
}
Run Code Online (Sandbox Code Playgroud)

您可以在替换中运行 javascript,并且您的操作非常简单:

${CLIPBOARD}.desc因为剪贴板将是对象。

带有对象描述的 jsdoc

请注意,光标必须位于对象内部的某个位置 - 即,在方括号/大括号内。