Koodilohkoina

Koodilohkoina on termi, jota käytetään erityisesti suomalaisessa teknisessä viestinnässä kuvaamaan tekstiosiota, jossa esitetään lähdekoodia tai konfiguraatiotiedostoja. Koodilohko on erillinen osa tekstiä, jossa rivien asettelu ja sisennykset säilyvät kuten alkuperäisessä koodissa, ja jonka tarkoitus on erottaa koodi muusta sisällöstä.

Koodilohkoja käytetään laajasti ohjelmointi- ja teknisissä julkaisuissa: dokumentaatiossa, oppaissa, tutoriaaleissa sekä wikeissä. Eri merkkausjärjestelmät tarjoavat omat keinonsa koodilohkoihin. Markdownissa käytetään sekä sisäkkäisiä lohkoja, joissa koodi indentataan neljällä välilyönnillä, että kolmen backtick -merkkien ympäröimiä lohkoja; HTML:ssä vastaava on pre- ja code-tägit. Muita järjestelmiä ovat esimerkiksi reStructuredTextin code-block -direktiivit ja AsciiDocin vastaavat rakenteet.

Hyödyt ovat selkeitä: koodilohko säilyttää väli- ja rivinvaihdot, parantaa luettavuutta ja helpottaa kopiointia. Monilla alustoilla koodilohko voidaan myös korostaa kielen mukaan, mikä parantaa ymmärrystä. On tärkeää muistaa, että koodilohko on esimerkki; se ei ole suoritettava ohjelma, eikä sitä tulisi käyttää arkaluontoisen tiedon siirtämiseen.

Yhteenveto: Koodilohkoina kuvaaminen on yleinen käytäntö teknisessä viestinnässä, joka parantaa selkeyttä ja reproduksoitavuutta eri julkaisuympäristöissä.