Fragments de codi ('Code Snippets') (tots els projectes)

Escrit per Brandon B. Stewart (traducció de Ramon Sala)


Disponible a través del menú Edició->Fragments ('Snippets')

L'Easy Code permet fer ús de fragments de codi i comentaris reutilitzables anomenats en anglès code snippets. Els snippets són blocs de codi de programa o comentaris del programador que normalment són petits, però poden variar en mida, propòsit o abast, i estan continguts en un fitxer de text estàndard (*.txt), o en un fitxer de llenguatge de marques extensible (*.xml). Els snippets estan formatats generalment en una mena de plantilla per tal que el fragment de codi o comentari(s) sigui inserit en el fitxer de destinació i necessiti els mínims canvis, de manera que funcioni com es requereix en cada cas particular.

Per mantenir la simplicitat, l'Easy Code només utilitza snippets emmagatzemats en format de text estàndard (*.txt). La nova subcarpeta "Snippets" de l'Easy Code ("..\EasyCode\Snippets") és el directori superior predeterminat dels snippets. Tot i així, a la finestra de 'Configuració', l'usuari pot especificar qualsevol carpeta alternativa on emmagatzemar els snippets. L'usuari pot crear qualsevol número de carpetes snippet dins de la carpeta superior. És una bona pràctica de programació limitar cada snippet a un únic fragment de codi, que serveix com una simple funció i anomenar cada snippet d'acord amb la funció particular que realitza. L'usuari no hauria de preocupar-se que això suposi tenir massa snippets, atès que cada carpeta i subcarpeta pot contenir un número il·limitat d'snippets. També és una bona pràctica emmagatzemar cada snippet en una carpeta de la qual el seu nom es correspongui directament amb el grup o tipus d'snippets que conté. Per exemple, tots els snippets que es refereixen al processament de fitxers haurien de posar-se en una subcarpeta amb un nom semblant a 'Processament de fitxers'. Els snippets que afegeixen capçaleres de comentaris al començament dels fitxers de codi o funcions s'haurien de posar en una subcarpeta amb un nom semblant a 'Comentaris de Capçalera'. Els snippets que manegin entrades i sortides a perifèrics s'haurien de posar en una subcarpeta anomenada 'Entrada i Sortida'. I així succesivament.


 


NOTA: El menú "Edició --> Fragments ('Snippets')" està enllaçat estàticament a la carpeta superior dels snippets i tindrà sempre el nom de "Fragments ('Snippets')", malgrat que l'usuari hagi triat una carpeta amb un altre nom. Contràriament, les etiquetes de cada submenú seran sempre dinàmiques, i d'aquesta manera el nom de cadascuna d'elles reflectirà la subcarpeta corresponent creada per l'usuari. A més, cada ítem de menú d'un snippet reflectirà sempre el nom de fitxer corresponent menys la seva extensió (txt). Com que el nom de cada snippet determinarà l'identificador que es mostrarà al menú Fragments ('Snippets'), és una bona pràctica anomenar cada fitxer amb un nom significatiu per tal que es pugui seleccionar fàcilment del menú.

Per tal d'inserir un snippet de codi o comentari, simplement s'ha de posar el cursor a la posició desitjada dins del fitxer de destinació, seleccionar Edició --> Fragments ('Snippets') del menú de l'Easy Code, navegar fins a la carpeta on es troba l'snippet, i llavors fer clic a l'ítem de l'snippet desitjat.

OBSERVACIONS: S'inclouen dos fragments de codi a la subcarpeta "..\EasyCode\Snippets\Header Comments".