JavaScript-navngivningskonventioner: må og må ikke

Jeg finder det forbløffende, hvor mange forskellige betydninger vi kan få fra mindre end 30 tegn. Jeg taler selvfølgelig om alfabetet med en velplaceret tegnsætning. Fra en kærlighedshistorie til et computerprogram har skrivning gjort det muligt for os at skabe ekstraordinært forskellige verdener. Og sprog giver generelt en ramme, hvor vi kan hænge en strøm af ideer.

De fleste programmeringssprog ser ud til at have meget strenge standarder - visse udtryk skal bruges visse steder. Men et område, hvor der er enorm frihed, er hvordan vi navngiver disse udtryk.

Tag dette enkle program, der opretter en sætning fra en række ord, tilføjer et tegnsætningstegn og logger det på konsollen:

Intet for specielt, ikke? Men hvad du måske ikke har overvejet, er hvor mange udtryk du var ansvarlig for at navngive.

Der er 23 ord (ikke inklusive hårdkodede værdier) i ovenstående program. Vi kontrollerede navnene på 14 af disse ord. Det er mere end 60% af det, der blev skrevet, var vores ansvar for at navngive!

Uanset om du bygger en virksomhedsapplikation eller en simpel Hello, World, vil du have, at dit program skal læses som en Times Bestseller, ikke en Mad Libs-projektmappe.

Dette er ikke et manifest om, hvordan man strukturerer en hel JavaScript-applikation, men snarere et kapitel om, hvordan man vælger navne til de ting, hvor man har friheden til at gøre det. Jeg har inkluderet de forskellige referencer i bunden, hvis du vil lære mere. En sidste ting, nøglen til afhentning af alle vores konventioner og standarder er dette:

De fleste af disse konventioner er ikke for dig i dag, men i stedet for dig og de mennesker, der læser din kode i morgen.

Referencer og fortsat læring

  1. “Clean Code” af Robert C. Martin - En fantastisk læsning til alle sprog. Det går ud over navngivningskonventioner og foreslår hele strukturen i dit program. Eksemplerne findes i Java, men principperne gælder JavaScript.
  2. “Clean Code JavaScript” af Ryan Mcdermott - Ovenstående bog, men omgjort til JavaScript. Det er tilgængeligt online og er gratis.
  3. Airbnb JavaScript Style Guide - muligvis den mest omfattende stilguide til JavaScript. Den indeholder ikke kun hvad, men også hvorfor. (Hvis du er på en lille enhed, skal du muligvis klikke på "se alle readme" for at se hele dokumentet).
  4. W3 JavaScript Style Guide - En kort og kort vejledning.
  5. Googles ES6 Style Guide - Googles stilguide til JavaScript.

Tak for læsningen!

woz

Følg mig på Twitter.