Les millors pràctiques per escriure un codi net

Els principis del codi net han derivat de dècades d'experiència d'alguns dels enginyers de programari més reconeguts del món. Aquest article se centrarà en les tècniques per escriure codi que sigui fàcilment comprensible per als membres del teu equip, per a tu i per a altres desenvolupadors.

Ens endinsarem en alguns dels esculls més comuns a l'hora d'escriure codi, especialment a mesura que els projectes es fan més grans i complexos. Els consells daquest article provenen de molts anys d'experiència treballant amb bases de codi d'alta qualitat en empreses com Google i Intuit.

Comentant el codi

Sovint es passen per alt els comentaris com a eina útil per escriure un codi net. El millor comentari és una frase ben escrita, però els comentaris poden proporcionar un context afegit al codi que es podria perdre si el codi no és comprensible. Els comentaris també es poden utilitzar per documentar el codi.

L'ideal és escriure un codi net que es documenti per si mateix, però un conjunt complet de codi ben documentat pot trigar molt de temps a crear-se, si es fa correctament. Si esteu treballant en una base de codi que no té una bona documentació, els comentaris poden ser una forma ràpida i fàcil d'afegir informació valuosa sobre el vostre codi.

Per exemple, si teniu una regla de negoci específica per calcular un valor al vostre codi, haureu d'afegir un comentari que expliqui la regla perquè el desenvolupador següent que hagi de modificar el codi entengui clarament com funciona. També hauríeu de comentar altres elements del codi, com la lògica de les funcions, l'ús de variables i les sentències condicionals.

No et repeteixis (DRY)

El principi DRY és un principi comú a l'enginyeria de programari i s'aplica a l'escriptura de codi. DRY significa “No et repeteixis”. Significa que has d'evitar duplicar el treball a la base de codi creant codi reutilitzable.

Duplicar codi a tota la base de codi és una mala pràctica. No només condueix a una base de codi que és desordenada i difícil de llegir, sinó que també fa més difícil modificar i ampliar el codi. Una base de codi neta conté una sola còpia de cada component, amb les entrades, sortides i funcionalitat adequades.

Si estàs tractant de resoldre un problema en un lloc, i després haver de tornar i resoldre aquest problema en un altre lloc, necessites trobar una manera de DRY fins al codi. Si tens un únic component de codi que és reutilitzable, pots utilitzar aquest component a múltiples llocs i evitar duplicar el codi.

Principi de responsabilitat única

Aquest és un dels principis més importants de l'enginyeria de programari, i és la base per escriure codi que sigui fàcil d'entendre i mantenir. El principi de responsabilitat única estableix que cada component del vostre sistema ha de tenir una i només una raó per canviar, i aquesta raó ha de ser òbvia.

Això vol dir que cada component del teu codi ha de tenir una sola responsabilitat, és a dir, una sola raó de ser. Si un component del vostre codi té més d'una raó de ser, aleshores aquest component hauria de dividir-se en components més petits amb una única raó de ser. L'exemple més comú és una funció que fa més d'una operació.

Sempre que escriviu una funció o un mètode, s'hauria de preguntar què fa exactament aquesta funció. Realitza una sola operació? Si feu més d'una cosa, llavors hauríeu de considerar dividir aquesta funció en dues o més funcions més petites que realitzin cadascuna una sola operació.

Fes servir noms de variables descriptius

Una altra de les millors pràctiques per escriure codi net és lús de convencions de nomenclatura descriptiva per a les variables. Les convencions de nomenclatura de variables són importants perquè s'utilitzen per ajudar els lectors a entendre el propòsit d'una variable o funció al codi.

Per exemple, si utilitzeu el nom de variable “i” per representar un índex en un bucle, un lector del vostre codi sabrà exactament el que representa aquesta variable sense haver de consultar els comentaris o la documentació.

Heu d'utilitzar convencions que tinguin sentit per al tipus de dades que esteu emmagatzemant en una variable. Per exemple, si emmagatzemeu una data en una variable, “date” és una bona opció per al nom de la variable. Si emmagatzemeu el nom d'un usuari en una variable, “nom” és una bona opció per al nom de la variable.

Escriure codi simple i refactoritzar contínuament

Mentre escrius codi, hauries de pensar sempre en com escriure'l de la manera més senzilla possible. T'hauries d'esforçar per aconseguir un codi que sigui fàcil de modificar, fàcil d'estendre i senzill de llegir.

De fet, hauries de refactoritzar constantment el teu codi mentre l'escrius. Hauries d'escriure unes quantes línies de codi, i després prendre't uns minuts per netejar el teu codi i fer-lo més fàcil de llegir. Si ho fas mentre escrius el codi, quan hi tornis més tard, et serà més fàcil entendre el que fa el codi perquè tot estarà escrit d'una manera única i directa.

Aquesta refactorització continua us ajudarà a escriure un codi que és més fàcil d'entendre ara, i més fàcil de modificar i ampliar en el futur.

Gestió d'errades

És preferible tornar les excepcions en lloc de manejar-les amb codi. Les excepcions són més clares i mantenibles si treballem amb aspectes (AOP), i les excepcions podrien ser fàcilment manejades si ho fem.

És crucial registrar el que ha passat al registre i fallar com més aviat millor, perquè puguem veure què passa i per què amb més precisió. Podem contextualitzar els errors i afegir pistes que ens ajudin a entendre perquè ha fallat alguna cosa, encara que no puguem reproduir les dades.

Quan treballem amb APIs o biblioteques externes, hem d'atrapar les seves excepcions i embolicar-les en les nostres excepcions per evitar l'acoblament. D'aquesta manera, el nostre codi estarà millor preparat per a futures modificacions.

Conclusió

Les millors pràctiques per escriure codi net que es discuteixen en aquest article són aplicables a la majoria dels llenguatges de programació. Si ets nou a la programació, o si vols millorar la qualitat del teu codi, hauries de fer un esforç per aprendre aquestes millors pràctiques i incorporar-les al teu codi.

El més important és recordar que escriure codi net és un procés iteratiu. No podràs escriure un codi que una altra persona pugui entendre la primera vegada que ho intentis. Cal temps, paciència i la voluntat d'aprendre dels errors.