如何修改JSDoc块注释代码

时间:2019-02-10 06:47:16

标签: typescript ecmascript-6 visual-studio-code

我可以修改默认的jsdoc注释以在新的锚点处添加其他星号吗?

以下是函数:

function method(param, param) {


}

这是我自动完成/**时VSC创建的:

/**
 * |
 * @param {*} | 
 * @param {*} |
 */

这是我想将其修改为:

/**
 * |
 * @param {*} | 
 * @param {*} |
 **/

2 个答案:

答案 0 :(得分:1)

当前行为的实现在这里:

https://github.com/microsoft/vscode/blob/master/extensions/typescript-language-features/src/features/jsDocCompletions.ts#L15

当前无法通过配置更改模板。

如果您不想对动态包含已定义的参数失去支持,则可以定义自己的代码段,如下所述:

https://code.visualstudio.com/docs/editor/userdefinedsnippets

答案 1 :(得分:1)

您可以尝试以下扩展程序:Document This

然后在Windows计算机上位于C:\Users\Mark\.vscode\extensions\joelday.docthis-0.7.1\out\src\utilities.js的代码中,编辑以下行:

   // sb.appendLine(" */"); // to

    sb.appendLine(" **/");

重新加载窗口,它似乎可以工作。

如果键入/**,将有两个选项:vscode的内置jsdoc'er和“文档此版本”。

如果您以前不为自己使用而扩展此扩展名,则可能需要重做编辑(如果扩展名将来会更新),但这很简单。

Ctrl - Alt - D + D 是快捷方式。

jsdoc extension demo

相关问题