szó jelentését keresi. A DICTIOUS-ban nem csak a
szó összes szótári jelentését megtalálod, hanem megismerheted az etimológiáját, a jellemzőit és azt is, hogyan kell a
szót egyes és többes számban mondani. Minden, amit a
szóról tudni kell, itt található. A
szó meghatározása segít abban, hogy pontosabban és helyesebben fogalmazz, amikor beszélsz vagy írsz. A
és más szavak definíciójának ismerete gazdagítja a szókincsedet, és több és jobb nyelvi forráshoz juttat.
Főnév
code block (tsz. code blocks)
- (informatika) A code block vagy magyarul kódtömb egy olyan szövegrészlet, amelyben programkódot, parancsokat vagy szkripteket jelenítünk meg egy dokumentumban, weboldalon, prezentációban vagy jegyzetben. A code block célja, hogy a kód olvasható, jól elkülönített és formázott módon jelenjen meg az adott szövegkörnyezetben, így a felhasználó könnyen meg tudja különböztetni a kódot a környező magyarázó szövegtől.
A code block kulcsfontosságú eleme a programozási oktatásnak, a dokumentációkészítésnek, a blogolásnak, és bármilyen olyan helynek, ahol kódot osztunk meg másokkal.
Alapfogalom
Egy code block olyan vizuális és/vagy szintaktikai keretet ad a kódnak, amely megőrzi a kód struktúráját és formáját. Leggyakoribb céljai:
- A kód szintaxisának kiemelése (syntax highlighting)
- A behúzások (indentation) és sortörések megtartása
- A kód vizuális elkülönítése a magyarázó szövegtől
- Könnyű másolhatóság biztosítása
Hol használunk code block-okat?
1. Markdown
A Markdown nyelvben a code block-okat általában három backtick (```) vagy három tilde (~~~) karakterrel jelöljük:
```python
def greet(name):
print(f"Hello, {name}!")
Ezzel a formázással a kód jól láthatóan elkülönül a szövegtől, és sok Markdown-megjelenítő (GitHub, GitLab, Jupyter Notebook, StackOverflow stb.) automatikusan kiemeli a kód szintaxisát a megadott nyelv szerint (itt: `python`).
---
### 2. HTML
A HTML-ben a `<pre>` és `<code>` tageket használjuk:
```html
<pre><code>
for (int i = 0; i < 10; i++) {
printf("%d\n", i);
}
</code></pre>
- A
<pre> (preformatted) tag biztosítja, hogy a szóközök és sortörések megmaradjanak.
- A
<code> tag pedig a kód logikai jelölésére szolgál.
3. Dokumentációs rendszerek
- Javadoc, Sphinx (Python), Doxygen (C++, C) stb. támogatják a code block-okat a dokumentációkban.
- Általában speciális szintaxisokat vagy direktívákat alkalmaznak (például
.. code-block:: python a Sphinx-ben).
4. Blogmotorok
- Szinte minden modern blogmotor (pl. WordPress, Ghost, Jekyll) támogatja a code block használatát, hogy a kód szépen jelenjen meg a bejegyzésekben.
Miért fontosak?
1. Olvashatóság
Kódot sosem jó „futó” szövegként közölni, mert:
- A behúzások elvesznek → a program logikai szerkezete követhetetlenné válik.
- Szintaxiskiemelés nélkül nehezebb megérteni a kód működését.
- Egyes karakterek (pl. <, >, &, `) félreérthetők lehetnek formázás nélkül.
2. Másolhatóság
A code block lehetővé teszi, hogy a felhasználók könnyedén kijelöljék és kimásolják a teljes kódrészletet hibamentesen.
3. Szintaxiskiemelés
- A modern editorok és dokumentációs rendszerek képesek a kódnyelv felismerésére és színezésére.
- Ez vizuálisan is segít a kód értelmezésében.
4. Kontextus
- A kódot nem önmagában, hanem kontextusban osztjuk meg: a code block elválasztja a kódot a magyarázó szövegtől.
- Könnyebb az olvasónak eldönteni, melyik részt kell futtatnia.
Fajtái
Inline code
Rövid kódrészleteket egy soron belül is megjelölhetünk:
Markdown:
`print("Hello")`
HTML:
<p>Használd a <code>print()</code> függvényt.</p>
Ez csak szavakat vagy rövid kifejezéseket emel ki a szövegben.
Block code
Nagyobb kódrészletekhez code block-ot alkalmazunk, hogy a teljes blokk jól látható legyen.
Jó gyakorlatok
- Mindig jelöld meg a használt nyelvet ha lehetséges (pl.
```python).
- Őrizd meg a behúzásokat, mert a legtöbb nyelvben (pl. Pythonban) a behúzás szintaktikai jelentésű.
- Ne tördelj kódot mesterségesen soron belül, inkább használd a megfelelő blokk formátumot.
- Kerüld az inline code használatát hosszabb kódnál → zavaróvá válik.
- Használj konzisztens stílust a teljes dokumentumban.
Példa
Markdown-ban:
## Python példa
```python
def fibonacci(n):
a, b = 0, 1
for _ in range(n):
print(a)
a, b = b, a + b
Eredmény:
```python
def fibonacci(n):
a, b = 0, 1
for _ in range(n):
print(a)
a, b = b, a + b
- GitHub automatikusan alkalmaz szintaxiskiemelést, ha megadjuk a nyelvet.
- StackOverflow ismeri a legtöbb népszerű nyelvet.
- Reddit kódtömbjeinél néha speciális szintaxist kell használni.
- WordPress beépülőkkel (pl. SyntaxHighlighter Evolved) képes szép kódblokk megjelenítésre.
Kódtömbök a programokban
A „code block” kifejezést programozás közben más értelemben is használjuk:
- C++ / C / Java / C# / JavaScript: a
{ ... } között lévő kódrészlet szintén code block.
if (x > 0) {
cout << "Positive";
}
Ebben az esetben a kódtömb a vezérlési szerkezethez tartozik, és határozza meg a scope-ot (hatókört).
Kódtömb vs. snippet
- Code block → teljes blokk, dokumentációban vagy oktatási anyagban.
- Snippet → rövid kódrészlet, gyakran IDE-ben (Visual Studio Code, IntelliJ IDEA) használt sablon.
Összefoglalás
A code block elengedhetetlen eszköz, ha kódot akarunk publikusan, mások számára olvasható formában megosztani:
✅ Megőrzi a kód formátumát ✅ Könnyíti az olvasást és a megértést ✅ Lehetővé teszi a pontos másolást ✅ Esztétikailag is javítja a dokumentációt ✅ Segít a hibák elkerülésében
Végszó
Ha valaha publikálsz kódot cikkben, e-mailben, dokumentációban, sose hagyd el a code block-ot. Ez a legfontosabb eszköz arra, hogy mások helyesen értsék, futtathassák és hasznosíthassák a megosztott kódot.
A mai szoftverfejlesztési ökoszisztémában jó code block használat az egyik legegyszerűbb, de leghatásosabb dokumentációs trükk, amit bárki elsajátíthat.