Ohjelmointityyli

Ohjelmointityyli on joukko sääntöjä tai ohjeita käytetään kirjoitettaessa lähdekoodi on tietokoneohjelma . Usein väitetään, että tietyn ohjelmointityylin noudattaminen auttaa ohjelmoijia lukemaan ja ymmärtämään tyylin mukaisen lähdekoodin ja välttämään virheitä.

Klassinen asiaa käsittelevä kirja  , Ohjelmointityylin elementit  (in) , on kirjoitettu 1970-luvulla, ja se on havainnollistettu Fortran- ja PL / I- ohjelmointikielien  esimerkeillä .

Hyvän tyylin elementit

Ohjelmointityylin laatu on herkkä arvio, jonka luonnehdinta on vaikeaa. Monissa ohjelmointityyleissä on kuitenkin yhteisiä elementtejä. Yleisesti tärkeimpinä pidettyjä näkökohtia ovat lähdekoodin asettelu, mukaan lukien sisennys; tyhjän alueen käyttö operaattoreiden ja avainsanojen ympärillä; avainsanojen ja muuttujien nimien isojen kirjainten käyttö; käyttäjän määrittelemien tunnisteiden tyyli ja oikeinkirjoitus; ja kommenttien käyttö ja tyyli .

Koodin ulkonäkö

Ohjelmointityylit käsittelevät yleensä lähdekoodin visuaalista puolta, tavoitteenaan sen luettavuus. Ohjelmisto, joka muotoilee lähdekoodin automaattisesti, on jo pitkään ollut käytettävissä, jolloin kooderit voivat keskittyä loogiseen nimeämiseen sekä yleisiin prosesseihin. Käytännössä lähdekoodin alustaminen tietokoneen avulla säästää aikaa.

Sisennys

Sisennys tyylejä avulla tunnistamaan virtauksen ohjaus ja logiikka lohkoja. Joillakin kielillä sisennystä käytetään loogisten koodilohkojen rajaamiseen; oikea sisennys näissä tapauksissa on vain tyylin asia. Toisissa sisennys ja välilyönti eivät vaikuta toimintaan, vaikka looginen ja johdonmukainen sisennys tekee koodista helpommin luettavissa. Vertailla:

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

tai

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

Jotain sellaista

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

Kahden ensimmäisen esimerkin pitäisi olla paljon helpompi lukea, koska ne on sisennytty yhteisellä tavalla. Tämä sisennystyyli on erityisen hyödyllinen käsiteltäessä sisäkkäisiä rakenteita. Huomaa kuitenkin, että tämä esimerkki voidaan tiivistää näin:

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

Lua ei käytä perinteisiä sulkeita tai  sulkeita . Jos lausunnot / muu vaativat vain ilmaus seuraa  then, ja opetusta  end.

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

Sisennys on valinnainen. and (et), or (ou)ja not (non) niitä käytetään tosi / väärien lausuntojen välillä.

Python

Python käyttää sisennystä osoittamaan ohjausrakenteita . Tällöin hakasulkeita ei enää tarvitse käyttää .

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

Monet Python-ohjelmoijat seuraavat yleensä tyyliopasta, joka tunnetaan yleisesti nimellä PEP8. On olemassa työkaluja, jotka on suunniteltu automatisoimaan PEP8-vaatimustenmukaisuus.

Pystysuuntainen suuntaus

Usein on hyödyllistä kohdistaa samanlaiset elementit pystysuoraan, jotta typografiaan liittyvät virheet olisivat selvempiä.

Joko seuraava koodi:

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

ja tämä:

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

Tämä viimeinen esimerkki tekee kaksi asiaa intuitiivisesti selväksi, enemmän kuin ne eivät olleet ensimmäisessä:

  • Haku- ja korvaustermit liittyvät toisiinsa ja vastaavat: ne eivät ole erillisiä muuttujia;
  • Hakutermejä on yksi enemmän kuin korvaavia termejä. Jos on vika, se havaitaan nyt todennäköisemmin.

Tilat

Välilyöntiä käytetään yleisesti luettavuuden parantamiseksi .

Mikä näkyy esimerkiksi seuraavissa syntaktisesti vastaavissa katkelmissa  C : ssä:

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

vastaan

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

vastaan

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

Katso myös

Viitteet

  1. "PEP 0008 - Python-koodin tyyliopas" . python.org. 

Ulkoiset linkit