Hyvä koodi vs. huono koodi: miksi hyvän koodin kirjoittaminen on tärkeää ja miten se tehdään

Kun kirjoitat koodia millä tahansa kielellä, on olemassa hyviä koodauskäytäntöjä - ja on todella huonoja.

Molemmat saattavat olla oikeita kokoamisessa ja ajon aikana. Mutta huono koodi voi aiheuttaa joitain ongelmia kehittämisessä, virheenkorjauksessa ja muokkaamisessa. Työpaikalla, riippumatta siitä, kuinka hyvin ohjelma toimii, jonkun on luettava ja / tai muutettava koodiasi jossain vaiheessa.

Heidän on ehkä lisättävä uusia ominaisuuksia, korjattava harvinainen virhe tai he ehkä haluavat lukea sen ymmärtääksesi miten se toimii. Samoin joudut lukemaan jonkun toisen koodin tehdäksesi saman asian. Jokainen tulee toimeen paljon paremmin, jos koodi on luettavissa ja ymmärrettävissä.

Ymmärtääksemme hyvälaatuisen koodin merkityksen yritämme ymmärtää, mihin huono laatu voi johtaa. Huonosti kirjoitettu koodi voi johtaa taloudellisiin menetyksiin tai ajanhukkaan, jota tarvitaan ohjelmiston jatkuvaan ylläpitoon, parannuksiin tai mukautuksiin.

Kirjoita koodi kerran, mutta seuraa sitä useita kertoja sen jälkeen. Siksi koodisi dokumentoinnista tulee todella tärkeä ja nimeämiskäytännöistä tulee todella tärkeitä.

Monta kertaa olen törmännyt kollegoihini leikillään siitä, kuinka he eivät muista mitä koodia tai logiikkaa he kirjoittivat muutama päivä sitten. Yhdistä se nyt kirjoittamalla huono koodityyli, ja otat enemmän aikaa ymmärtääksesi tekemäsi. Asiat alkavat mennä hyttynä, kun taiteilija ei ymmärrä omaa teostaan ​​

Tärkeimmät seikat, jotka tulee pitää mielessä koodia kirjoitettaessa

// Kommentit pelastamiseen

Suurimmalla osalla nykyaikaisista kielistä on deklaratiivisesti dokumentoituja kommentteja, ja niiden käyttö yhdessä yhden ja monirivisten kommenttien kanssa tekee koodista ymmärrettävämmän - ja siten ylläpidettävän.

Hyvät koodikommentit selittävät, miksi asiat tehdään, ei mitä tehdään. Itse koodi selittää mitä tehdään. Kommenttien tarpeen pitäisi olla vähäinen.

sisennys

Hyvä koodi on rakennettu oikein kuvan osoittamalla tavalla. Koodin ymmärtämiseen yrittävän tulisi olla selvää, missä koodilohko alkaa ja missä se päättyy, jotta koodikannan logiikan noudattaminen käy ilmi ja suoraviivainen.

Kaltevuus: Normaali normi 4 -välilause

readme n

Se on ärsyttävää, kun projektin koodituki on edessäsi, mutta asennus ja ensimmäinen suorittaminen vie tunteja saadaksesi sinut liikkumaan. Täältä Readme on hyödyllinen.

Aina on parempi saada lyhyt esittely projektiin ennen koodin käyttöä, ja oikein jäsennelty Readme tekee juuri sen. Oikein jäsennelty Readme näyttää seuraavalta:

Nimeämiskäytännöt

Monta kertaa törmäämme luokalle nimellä Apimanager, mutta nimeä tarkasteltaessa luokan tarkoitus ei ole selvä.

Parhaiden koodauskäytäntöstandardien mukaan luokkiemme tulisi noudattaa yhden vastuun periaatetta (SRP). Oikeiden nimeämiskäytäntöjen ja SRP: n yhdistäminen tekee elämästämme paljon helpompaa yrittäessämme seurata projektia.

Nimetyskäytäntöjen tulisi myös vaihdella eri laajuuksien mukaan, jos luokka suorittaa jotain intensiivistä työyksikköä. Tämän tarkoituksena on erottaa toisistaan, milloin ja missä muuttuja tulee laajuuden ulkopuolelle vain tarkastelemalla koodilohkoa.

Käytä merkityksellisiä nimeämiskäytäntöjä kaikille paitsi kaikkein ohimenevimmille kohteille. Jokin nimi on informatiivinen siitä, milloin ja miten objektia käytetään.

Vältä taikuutta

Mikä on maaginen numero? Se on vakio, täysin dokumentoimaton, jonka on oltava erityinen arvo, jotta ohjelma toimii oikein. Kukaan ei tiedä miksi tämä numero valittiin.

Taikaellisimmalla tavalla kukaan ei oikein tiedä kuinka numero vaikuttaa ohjelmaan ... paitsi että sen muuttaminen rikkoo asioita.

Maagiset numerot ovat pahoja, ja ne tulisi poistaa nähdessään.

Sopeutuminen aikakehykseen

Seuraava kuva puhuu puolestaan.

Koodin laatu määräaikoihin

Yleiset käytännöt puhtaan, laadukkaan koodin kirjoittamiseen

Laajasti käytetyt vaiheet koodin laadun parantamiseksi

Laadukkaan koodin kirjoittaminen on dynaaminen prosessi. Muutamia huomioitavia seikkoja yritettäessä kirjoittaa ”hyvä koodi”:

  • Hyvä koodi on hyvin järjestetty. Tiedot ja operaatiot luokissa sopivat yhteen. Luokkien välillä ei ole vieraita riippuvuuksia. Se ei näytä "spagetilta".
  • Hyvä koodi on hyvin testattu. Testit toimivat koodin suoritettavana eritelmänä ja esimerkkeinä sen käytöstä.
  • Hyvä koodi ei ole “fiksu”. Se tekee asiat suoraviivaisella, ilmeisellä tavalla.
  • Hyvä koodi on kehitetty pieniin, helposti luettaviin laskentayksiköihin. Näitä yksiköitä käytetään uudelleen koko koodissa.

Kiitos käsittelystä, jaa se, jos pidit siitä hyödyllistä :)