Programmeringsstil

Den programmering stil er et sett med regler eller retningslinjer som benyttes ved skriving av kildekoden til et dataprogram . Det hevdes ofte at å følge en bestemt programmeringsstil vil hjelpe programmerere å lese og forstå kildekoden som samsvarer med stilen, og vil bidra til å unngå feil.

En klassisk bok om emnet,  av elementene i programmering stil  (i) , er skrevet i 1970, og illustrert med eksempler på programmeringsspråk  Fortran og PL / I .

Elementer av god stil

Kvaliteten på en programmeringsstil er en delikat vurdering, og karakteriseringen er vanskelig. Imidlertid er det elementer som er felles for mange programmeringsstiler. Aspekter som generelt anses å være store er utformingen av kildekoden, inkludert fordypningen; bruk av hvite mellomrom rundt operatører og nøkkelord; store bokstaver i nøkkelord og variabelnavn; stilen og stavemåten til brukerdefinerte identifikatorer; og bruk og stil av kommentarer .

Kode utseende

Programmeringsstiler håndterer generelt det visuelle aspektet ved kildekoden, med målet om lesbarhet. Programvare har lenge vært tilgjengelig som automatisk formaterer kildekoden, og lar koderne fokusere på logisk navngiving så vel som generelle prosesser. I praksis sparer du tid ved å bruke en datamaskin til å formatere kildekoden.

Innrykk

Den skår stiler hjelp identifisere flytkontroll og logiske blokker. På noen språk brukes innrykk for å avgrense logiske kodeblokker; riktig fordypning i disse tilfellene er bare et spørsmål om stil. I andre påvirker ikke innrykk og plass funksjon, selv om den logiske og konsistente innrykk gjør koden mer lesbar. Sammenligne:

if (hours < 24 && minutes < 60 && seconds < 60) { return true; } else { return false; }

eller

if (hours < 24 && minutes < 60 && seconds < 60) { return true; } else { return false; }

Med noe sånt som

if ( hours < 24 && minutes < 60 && seconds < 60 ) {return true ;} else {return false ;}

De to første eksemplene skal være mye lettere å lese, ettersom de er innrykket på en vanlig måte. Denne stilen av innrykk er spesielt nyttig når du arbeider med nestede konstruksjoner. Vær imidlertid oppmerksom på at dette eksemplet kan oppsummeres slik:

return hours < 24 && minutes < 60 && seconds < 60; Lua

Lua bruker ikke tradisjonelle parenteser eller  parenteser . De hvis uttalelser / annet krever bare uttrykket er etterfulgt av  then, og instruksjon  end.

if hours < 24 and minutes < 60 and seconds < 60 then return true else return false end

Innrykk er valgfritt. and (et),, or (ou)og not (non) brukes mellom sanne / falske utsagn.

Python

Python bruker innrykk for å indikere kontrollstrukturer . Ved å gjøre dette er det ikke lenger nødvendig å bruke parentesene .

if hours < 24 and minutes < 60 and seconds < 60: return True else: return False

Mange Python-programmerere har en tendens til å følge en stilguide, kjent som PEP8. Det er verktøy designet for å automatisere PEP8-samsvar.

Vertikal justering

Det er ofte nyttig å justere lignende elementer vertikalt, for å gjøre typografirelaterte feil mer tydelige.

Enten følgende kode:

$search = array('a', 'b', 'c', 'd', 'e'); $replacement = array('foo', 'bar', 'baz', 'quux'); // Another example: $value = 0; $anothervalue = 1; $yetanothervalue = 2;

og denne:

$search = array('a', 'b', 'c', 'd', 'e'); $replacement = array('foo', 'bar', 'baz', 'quux'); // Another example: $value = 0; $anothervalue = 1; $yetanothervalue = 2;

Dette siste eksemplet gjør to ting intuitivt klare, mer enn de var i den første:

  • Søk og erstatt termer er relatert og samsvarer: de er ikke diskrete variabler;
  • Det er ett søkeord mer enn erstatningstermer. Hvis det er en feil, er det mer sannsynlig at den blir oppdaget.

Plasser

White space-stilen brukes ofte for å forbedre lesbarheten .

Som vises for eksempel i følgende syntaktisk ekvivalente utdrag i  C :

int i; for(i=0;i<10;++i){ printf("%d",i*i+i); }

mot

int i; for (i=0; i<10; ++i) { printf("%d", i*i+i); }

mot

int i; for (i = 0; i < 10; ++i) { printf("%d", i * i + i); }

Se også

Referanser

  1. "PEP 0008 - Style Guide for Python Code" . python.org. 

Eksterne linker