【问题标题】:How to modify the JSDoc block comment code如何修改 JSDoc 块注释代码
【发布时间】:2019-07-03 23:21:08
【问题描述】:

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

这里是函数:

function method(param, param) {


}

当我自动完成/** 时,VSC 会创建以下内容:

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

下面是我要修改的内容:

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

【问题讨论】:

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


【解决方案1】:

当前行为的实现在这里:

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

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

如果您愿意放弃对已定义参数的动态包含的支持,您可以定义自己的 sn-p,如下所述:

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

【讨论】:

    【解决方案2】:

    你可以试试这个扩展:Document This

    然后在 Windows 机器上......\.vscode\extensions\joelday.docthis-0.7.1\out\src\utilities.js 的代码中,编辑这一行:

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

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

    如果你输入/**你会得到两个选项:vscode的内置jsdoc'er和Document This version。

    如果您以前没有为自己使用分叉此扩展程序,如果将来更新扩展程序,您可能需要重新进行编辑 - 但这很简单。

    Ctrl-Alt-D+D是快捷键。

    【讨论】:

      猜你喜欢
      • 2011-09-20
      • 2015-06-02
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 2014-07-15
      • 1970-01-01
      相关资源
      最近更新 更多