koodilohkojen

Koodilohkojen käsite viittaa esitystapaan, jossa ohjelmointikoodi tai komentorivikäskyt esitetään selvästi erillään muun tekstin joukosta. Koodilohkojen tarkoitus on säilyttää koodin muoto, sisennykset ja rivinvaihdot, jotta lukija näkee nopeasti, mistä esimerkki alkaa ja loppuu. Ne ovat keskeisiä ohjelmointi- ja teknisen dokumentaation yhteydessä sekä verkkosivuilla ja oppimateriaaleissa.

Koodilohkoja tuetaan useissa merkkaus- ja julkaisujärjestelmissä. Markdownissa niitä voidaan muodostaa joko kolmen backtickin tai neljän välilyönnin sisennyksen avulla; alkuun voidaan lisäksi lisätä ohjelmointikielen tunniste, mikä mahdollistaa syntaksin korostuksen. HTMLissä koodilohkoja tuetaan pre- ja code-elementtien avulla. Joissakin järjestelmissä käytetään myös reStructuredTextin tai AsciiDocin erityisiä lohkomerkkauksia.

Koodilohkojen ja inline-koodin välillä on ero. Inline-koodi sijoitetaan rivin sisään pienemmillä merkinnöillä, kun taas koodilohkot muodostavat erillisen, omalle rivilleen ilmestyvän lohkon. Koodilohkon sisällöstä tehdään usein kopioitava ja kokeiltava.

Hyötyjä ovat parempi luettavuus, helpompi virheiden toistaminen ja syntaksin korostus, mikä auttaa ymmärtämistä. On hyvä idea pitää lohko lyhyinä, lisätä kommentteja ja estää arkaluontoisten tietojen esiintyminen sekä kannustaa lukijoita käyttämään omia testikäyriä.

Koodilohkoja käytetään laajasti ohjelmistoprojekteissa, ohjelmointihankkeiden dokumentaatiossa, koulutusmateriaaleissa sekä teknisillä blogeilla.