når du tilmelder dig et nyt projekt eller læser en open source-kode, skal du have bemærket, at nogle projekter er ensartet organiserede og velstrukturerede, mens andre er rodet og sammenfiltret? Hvis vi opsummerer de faktorer, der giver en sådan effekt over kodebasen, kommer vi på tværs af begrebet kodekonvention.

lad os opdage:

  • Hvad er kodekonventioner?
  • hvordan deres vedtagelse kan resultere i store fordele for dit projekt?
  • Hvad er det?
  • og hvilke hurtige kode stilarter at vælge?

definition af Hurtig Kodekonvention

Kodekonvention er et sæt dos og Don ‘ ts, der beskriver filorganisation, programmeringspraksis, designmønstre, arkitektonisk tilgang osv. Det kan være et formelt sæt regler, der følges af et team, organisation eller individ, eller være så uformel som en vane med at anvende visse kodningspraksis.

kodestil er en delmængde af kodekonvention, der styrer filformatering, såsom indrykning, kommas placering, seler, store bogstaver osv. I hurtigt samfund sondres der normalt ikke mellem de to, og det almindelige udtryk hurtig kodestil eller undertiden hurtig stilguide bruges.

sådan kan kodningskonventioner se ud:

  • filnavn: en fil, der indeholder en enkelt type, skal have samme navn som typen.
  • Linjelængdegrænse: en enkelt kodelinje må ikke overstige 160 tegn.
  • navngivning: variabler er lowerCamelCase.

Hvorfor bruge Hurtig kodestil

enhver hurtig Udvikler ved, at sproget har et enormt potentiale, som igen kan bringe masser af kompleksitet, gøre kode sammenfiltret og svært at læse og vedligeholde. Derfor er kernemålet med hurtig kodestil at reducere denne kompleksitet ved at beskrive god og dårlig praksis med at skrive hurtig kode.

hvorfor gør kode lettere at læse er så vigtigt?

ifølge Robert C. Martin er den tid, vi bruger på at læse koden, over 10 gange mere end at skrive den. Desuden læser vi konstant eksisterende kode for at skrive den nye.

en anden undersøgelse fra fakta og fejl i Programmelteknik siger, at 40% -80% af de samlede programomkostninger går til vedligeholdelse.

lad os opsummere fordele, som hurtig stilguide giver:

  • hjælper med at forstå projektstrukturen.
  • forbedrer kode læsbarhed.
  • gør vedligeholdelse lettere.
  • fremskynder onboarding for nye teammedlemmer.
  • giver mulighed for at mestre bedste programmeringspraksis.
  • bliver et kommunikationsværktøj mellem programmører i samfundet.

på grund af en så stor indflydelse vedtages kodningskonventioner normalt af IT-organisationer og endda hele programmeringssamfund.

design af en kodestil fra bunden er en ikke-triviel opgave og kræver konsolideret indsats. Heldigvis behøver vi som hurtige udviklere ikke at genopfinde hjulet og kan bruge flere eksisterende hurtige stilguider.

lad os udforske de mest fremtrædende hurtige kodningsformer mere detaljeret.

udforskning af hurtige Kodestilarter

definitionen af god kodestil er subjektiv, og min personlige anbefaling er at uddybe flere stilarter og forme dem efter dine projektbehov. Nedenstående liste er her for at hjælpe.

1. Swift.org

denne vejledning er en standard som standard i hurtig samfund. Det konsoliderer det absolutte minimum af regler, som enhver hurtig Udvikler skal forstå og følge.

guiden fokuserer på grundlæggende aspekter af hurtigt API-design, som efterfølges af alle systemrammer. Ikke kun det får din kode til at se organisk ud i forbindelse med system API ‘ er, men gør det også lettere at læse og forstå Kakaorammer.

alene, Swift.org kodestil er ikke nok til at give et omfattende sæt regler, men det er en god tilføjelse til de andre guider, der er anført nedenfor.

Link: Swift.org kode stil

2. Google

du støder normalt ikke på ‘Google’ og ‘hurtig’ i en sætning, men ikke denne gang. Google forstår utvivlsomt vigtigheden af kodekonventioner og skaber konventioner til alle større open source-projekter, som det fremgår af Google Style Guides. Mit gæt er, at vi skal takke Tensorstrøm for denne hurtige guide.

denne hurtige kodestil imponerer med dens omfattende. Det dækker så mange aspekter, at blot en liste over dem her ville gøre denne artikel dobbelt så lang.

hvad der virkelig er værdifuldt ved denne vejledning er, at hvert punkt er velbegrundet ved at Liste god programmeringspraksis, som ofte er grundlæggende for alle sprog. Programmeringspraksis sektion, som jeg stærkt anbefaler at læse, om du leder efter en hurtig guide eller ej, skinner virkelig i dette aspekt.

efter at have læst og forstået denne vejledning vil du finde dig selv en bedre programmør generelt samt tilføje en masse hurtige tricks i lommen.

Link: Google hurtig kode stil

3. Ray Venderlich

holdet bag raywenderlich.com er velkendt i iOS samfund og behøver ikke en særlig introduktion. Samme som Rays artikler gør, er guiden skrevet på en klar og forståelig måde og er især velegnet til hurtige nykommere

denne vejledning når utvivlsomt de angivne mål om at være klar, konsistent og kort. Hver regel efterfølges af en komplet forklaring, ræsonnement og et sæt eksempler med dos and don ‘ ts.

det, jeg elsker ved denne vejledning, er, at det går ud over hurtig syntaks og kodeformatering og forklarer god programmeringspraksis, såsom undgåelse af ubrugt kode, forklarer forskellen mellem værdi-og referencetyper, begreberne doven initialisering, adgangskontrol, tidlige afkast og meget mere.

på det tidspunkt, jeg skriver denne artikel, har den allerede 137 lukkede pull-anmodninger, der viser, at guiden er stærkt understøttet af samfundet.

Link: Ray Venderlich hurtig kode stil

4. LinkedIn

LinkedIn gør et godt stykke arbejde med at åbne sourcing af deres interne komponenter, og hurtige er ikke en undtagelse. Deres hurtige stilguide har eksisteret i over 3 år og indarbejdet masser af forbedringer fra både open source-samfund og LinkedIn-team.

LinkedIn hurtig guide er kort, kortfattet og velstruktureret. Korte teoretiske forklaringer gives ofte for bedre at forstå ræsonnementet bag visse regler. Eksemplerne er altid selvforklarende og viser tydeligt pointen.

guiden fokuserer primært på kodeformatering, og jeg anbefaler stærkt at bruge den i kombination med andre hurtige kodestilarter fra denne liste.

Link: LinkedIn hurtig kode stil

5. Airbnb

Airbnb team er kendt for deres værdifulde bidrag til iOS samfund. På det tidspunkt skriver jeg denne artikel, Airbnb hurtig stil Guide er bare 1 uge gammel, hvad der gør det til det friskeste på denne liste.

helt fra starten sætter guiden den rigtige kontekst ved at forklare, hvorfor du har brug for en kodestil, og jeg er helt enig i hvert punkt.

Guiden er en fornøjelse at læse: den er velstruktureret, og reglerne forklares nøjagtigt. Hvor det giver mening, ledsages hvert punkt med eksempler på dos og dont og teoretisk kontekst. Næsten hver regel er lavet lintable med Hurtiglint-et statisk analysatorværktøj, der vil blive diskuteret få afsnit nedenfor.

jeg kan især godt lide mønstre sektion, hvor Airbnb giver praktiske hurtige råd, som jeg stærkt anbefaler at tjekke. For eksempel, det prescripts at bruge uforanderlige værdier i stedet for mutable og giver tips om Enums definition. Min favorit er håndteringen af uventede forhold, hvor brugen af påstande, forudsætninger og fatale fejl forklares i detaljer.

guiden indeholder endda Indstillinger for Kodeeditor for at opfylde reglerne fra Formateringsafsnittet, som let kan anvendes som et script.

Link: Airbnb hurtig stil Guide

hurtig kode Linter Hurtiglint

vi er alle mennesker og bevidst eller ej, vi alle laver fejl. Det er således ikke nok at dokumentere eller mundtligt blive enige om hurtige kodningskonventioner. For at minimere antallet af fejl skal reglerne håndhæves af et automatiseret værktøj, kendt som linter.

Linter er en statisk kodeanalysator, der finder programmeringsfejl, fejl, formateringsfejl og potentielt skadelige konstruktioner.

Hurtigkodeanalysator er den mest anvendte hurtigkodeanalysator, der kan konfigureres baseret på brugerdefinerede regler. Hvis du ikke bruger det allerede, anbefaler jeg stærkt at kontrollere det og begynde at bruge det i dine hurtige projekter så hurtigt som muligt.

den vigtigste ting at forstå er, at den ikke håndhæver en ‘single true style’, men hjælper med at være konsistent i et projekt.

Resume

ensartede kodekonventioner bidrager meget til programmeringsproduktiviteten, og vi vil altid være så produktive som muligt.

listen med de mest bemærkelsesværdige hurtige kodningsformer er en god kilde til hurtig bedste praksis og et udgangspunkt for at uddybe dit eget sæt konventioner.

god hurtig kodestil er subjektiv og bør overlades til dig og dit holds overvejelse. Når den er godkendt og dokumenteret, sådan stil bliver en standard og skal være konsistent på tværs af projektet for at forbedre læsbarheden, hvilket resulterer i adskillige fordele.

vi er et bredt vedtaget værktøj i hurtigt samfund, der hjælper med at håndhæve kodningskonventioner. Det hjælper med at undgå menneskelige fejl tidligt og kan være en værdifuld tilføjelse til dit projekts værktøjsstabel.

Skriv et svar

Din e-mailadresse vil ikke blive publiceret.