koodilohkoille

Koodilohkoille on suomenkielinen termi, jota käytetään kuvaamaan ohjelmointikoodia esittävää lohkoa tekstissä tai dokumentaatiossa. Muodollisesti koodilohko on koodin erillinen osa, joka asetetaan näkyvästi erilleen muun tekstin joukosta ja jonka sisältö säilyttää alkuperäisen rivirakenteen sekä usein monospace-fontin ja syntaksin korostuksen. Koodilohkoille muodostaa allatiivin muotoa koodilohkoille, joka puolestaan viittaa "to code blocks" tai "for code blocks" -sijaintiin tai kohteeseen.

Koodilohkojen käsite on yleinen ohjelmointi- ja teknisessä viestinnässä. Niitä käytetään sekä opetuksellisissa materiaaleissa että dokumenteissa, joissa halutaan varmistaa, että koodiesimerkit erottuvat selkeästi muun tekstin joukosta. Koodilohkoja voidaan esittää eri tavoilla riippuen käyttötavasta: monospaced-tyyppinen esitys, syntaksin korostus sekä rivin sisällön tarkka rivijärjestys ovat tyypillisiä piirteitä. Tavanomaisia toteutuksia ovat esimerkiksi Markdownin koodilohkot, HTML:n pre/code-elementit tai muu vastaava esitystapa, joka säilyttää koodin muotoilun ja rivinvaihdot.

Käyttötapoja ja huomioita koodilohkoille ovat muun muassa oikean kielen tai koodilajin mainitseminen lohkon ylä- tai alapuolella, selkeä erottelu prose-tekstistä sekä mahdollisuus kopioida helposti koodin sisältö ilman muokkausta. Koodilohkoille laadittu ohjeistus voi korostaa myös hyviä käytäntöjä, kuten sisennyksen ylläpitoa ja aakkostettuja rivejä, jotta esimerkki on todennettavissa ja toistettavissa.

Lisäksi termiä voidaan tarkastella kieliopillisesti: koodilohko on yhdyssana, ja koodilohkoille on monissa yhteyksissä käytetty allatiivin muoto, kun viitataan toimintaan tai sijoituspaikkaan koodeille. Tämä muotoa käytetään yleisesti teknisessä kirjoituksessa silloin, kun puhutaan siihen sijoitettavista tai sitä koskevista toimenpiteistä.