Como crear Snippets personales en VS Code

Como crear Snippets personales en VS Code

Inicio < Blog < Tutoriales < Como crear Snippets personales en VS Code

31 de Mayo del 2020

En el Tutorial crearemos snippets personales que nos ayudarán a programar velozmente sin preocuparse de sintaxis o detalles.

Más de alguien abra descargado una extensión de Snippets de VS Code, pero ¿Porqué no crear los que sean más usados por uno?

Es muy simple y debemos hacer lo siguiente:

1) En el Menú superior de VS Code elegimos Archivo, luego Preferencias para finalmente elegir Fragmentos de código del usuario.

2) En la mitad de VS Code se desplegará un listado de opciones, para el Tutorial seleccionaremos php.json


3) Se abrirá el archivo de fragmento de código php.json, como verán hay una explicación y  ejemplo que está comentado además de algunos snippets que he creado.


4) La estructura es muy simple:

1 “Título General”:{
2 “prefix”:“NombreCortoParaLlamarlo”,
3 “body”:[
4 "# $1"
5 ],
6 “description”:“Comentario corto.”
7 }

A continuación explico línea por línea:

  • En la línea 1 debe estar dentro de comillas dobles y es el título general, le siguen 2 puntos (:) y la llave de apertura.
  • En línea 2 corresponde a un nombre corto, el cual al escribir en el código aparecerá en un listado al cuál podremos elegir.
  • De línea 3 al 5 es el cuerpo que aparecerá en nuestro código, en el ejemplo es para que aparezca un comentario con el signo #, y el $1 corresponde a la ubicación del cursor para empezar a escribir, pueden existir más de 1 que debe estar numerados desde el uno, por ejemplo: # $1 $2….
  • Línea 6 trata de la descripción corta de que trata el snippet, debe ser bien corto para poder visualizarlo al llamar el snippet
  • Finalmente la línea 7 se cierra con ‘}’, si queremos escribir otro snippet se debe agregar un símbolo COMA (,)

4) Por ejemplo el prefix es todoPHP, escribimos ‘todo’ y aparecerá un recuadro que aparece el prefix completo de todoPHP y se ve parte de ‘description’.


5) Aparecerá la estructura que se escribió dentro de body, fíjense que el cursor que es la línea vertical roja está a la derecha del símbolo # y en la ubicación de $1:


Puede que el ejemplo visto es muy simple, ahora verán uno que lo utilizo como encabezado de mis archivos PHP para comenzar a escribir documentación, tiene 15 variables ($1...$15) y el objetivo es documentar la lógica del archivo:


Bueno, espero que el Tutorial les haya servido ¿Qué snippet crearían?

¿Qué opinas?

Conversemos

Nombre (*)

Correo (*)

País (*)

Mensaje (*)

(*) Requerido




Newsletter:

Suscríbete GRATIS a nuestros correos electrónicos para recibir actualizaciones periódicas, ofertas, descuentos exclusivos y un excelente contenido GRATUITO.