Búsqueda de sitios web

typescript - Cómo modificar el código de comentario de bloque JSDoc


¿Puedo modificar el comentario jsdoc predeterminado para agregar un asterisco adicional en un nuevo ancla?

Aquí está la función:

function method(param, param) {


}

Esto es lo que VSC crea cuando autocompleto /**:

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

Aquí está lo que quiero modificar a:

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

Respuesta #1

La implementación para el comportamiento actual está aquí:

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

Actualmente no es posible cambiar la plantilla a través de la configuración.

Si está dispuesto a perder el soporte para la inclusión dinámica de parámetros definidos, puede definir su propio fragmento, como se describe aquí:

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

Respuesta #2

Podrías probar esta extensión: Document This.

Y luego, en su código en ......\vscode\extensions\joelday.docthis-0.7.1\out\src\utilities.js en una máquina con Windows, edita esta línea:

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

    sb.appendLine(" **/");

Recarga la ventana y parece funcionar.

Si escribes /** obtendrás dos opciones: el jsdoc incorporado de vscode y la versión Document This.

Si no haces un fork formal de esta extensión para tu propio uso, es posible que tengas que rehacer la edición si la extensión se actualiza en el futuro, pero es bastante simple.

Ctrl-Alt-D+D es el atajo.