MEGJEGYZÉSEK ELHELYEZÉSE A KÓDBAN
6. LECKE
Kód írása során az egyszerűségre, könnyen értelmezhetőségre törekszünk. Viszont, ahogyan haladunk előre és megyünk bele összetettebb feladatokba, a programjaink egyre inkább bonyolódnak majd.
💬 Személyes gondolatok:
Képzeld el, hogy hetekkel később újra megnyitod a saját kódodat.
A sorok ismerősek, de már nem emlékszel, miért írtad így.
Pont ezért léteznek a megjegyzések – apró üzenetek a múltbeli énedtől, hogy a jövőbeli te megértse, mit gondoltál akkor.
Például:
# Két számot összeadunk
result = x + y
👉 A “# Két számot összeadunk” sor nem a gépnek szól, hanem neked, hogy emlékezz, mit számoltál ki.
A lecke tartalma
I. Milyen problémákra ad megoldást a "kód megjegyzés"?
Valahogyan emlékeznünk kellene a korábban megtanult vagy folyamatba helyezett dolgokra. Ez különösen rendszeres jelenség és mindenkivel előfordulhat például abban az esetben, ha elkezd egy hosszabb programot írni, majd egy kihagyott időszak után visszatér az adott projekthez.
A kódolási folyamat nyomon követésével sok fölösleges keresgéléssel és program értelmezésével töltött órákat takaríthatunk meg.
A fentiekben említett példa arra a helyzetre vonatkozik, amikor a programozónak segítségre lehet szüksége, amikor több projekten dolgozik egyszerre.
Egy másik gyakori probléma az, amikor sok programozót bíznak meg egy nagyobb szoftver fejlesztésével.
Mivel egy feladatot sokféleképpen lehet megoldani, rengeteg megoldás születhet. Viszont mindenki a saját logikája alapján építi fel a szkriptjét vagy programban írt kódját. Valaki lépésekre lebontva jeleníti meg a kódját a szerkesztőben, mások pedig több lépést összevonva egy sorban írják le az utasítást és ez is egy megoldás azok számára, akik még kevesebb kódot írva szeretnék ugyanazt az eredményt elérni.
Néha nehéz lehet a fejlesztők céljaira következtetni a kódjaikból. Az viszont bosszantó lehet, ha a programozóknak ezt egy kapcsolatfelvétel után még külön át kell beszélniük. Fölösleges, extra időigényes folyamat lehet.
A kódokban való megjegyzések elhelyezése pont ezt a nehézséget kezeli, a programunk könnyebb átláthatóságra, értelmezésre nyújt megoldást.
A programozó megjegyzései betekintést nyújtanak a céljaiba és az egyéni logika alapján felépített folyamatokba.
Fontos!
A Python szintaktikai szabályok nem érvényesek a megjegyzésekre. Lehet nyelvtől és karakterektől függetlenül szabadon írni. A Python észleli, hogy megjegyzésről van szó a kódban, ezért ezt figyelmen kívül hagyva nem fogja utasításként végrehajtani vagy a konzolban megjeleníteni. Ha először a # jelet nem vesszük véletlen figyelembe, a megjegyzést a PyCharm szerkesztőben az inaktív szürke betűszínről lehet leghamarabb felismerni.
A megjegyzés a Pythonban így néz ki: # (kettőskereszt a sor elején)
A # szimbólum a sor elején azt jelzi, hogy megjegyzésről van szó.
Írjuk be az alábbi kódot megjegyzéssel együtt:
A videóban bemutatott kód:
x = 5
y = 35
# Két számot összeadunk
result = x + y
# végeredmény: 40
print(result)
Output:
Amint láthatjuk a konzolban a megjegyzések egyáltalán nem jelennek meg, csak a végrehajtott művelet eredményét láthatjuk:
40
1. Egysoros megjegyzés (Single-line Comment)
# Üdvözlő üzenet
print("Üdvözlet a Python csodálatos világában!")
Output:
Üdvözlet a Python csodálatos világában!
2. Többsoros megjegyzések (Multi-Line Comments)
A videóban bemutatott kód:
# Ez egy
# többsoros
# megjegyzés (Multi-Line Comments)
print("Üdvözlet a Python csodálatos világában!")
Output:
Üdvözlet a Python csodálatos világában!
3. Soron belüli megjegyzések (Inline Comments)
A videóban bemutatott kód:
currency = "HUF" # Magyar Forint
amount = 50000 # Összeg
print(amount, currency) # Összeg és pénznem együtt
Output:
50000 HUF
4. Docstring megjegyzések (Docstring Comments)
A Docstring egy olyan karakterláncot alkot, ami nincs hozzárendelve egyetlen változóhoz sem, ezért a Python figyelmen kívül hagyja és nem értelmezi ezt.
A videóban bemutatott kód:
""" Kassza adatai"""
currency = "HUF"
amount = 50000
""" Összeg és pénznem kiíratása """
print(amount, currency)
Output:
50000 HUF
5. Többsoros Docstring megjegyzések
A videóban bemutatott kód:
"""
Ez egy
több
soros
megjegyzés
"""
print("Hello Python!")
Output:
Hello Python!
A megjegyzés az konzol output-től független. Teljesen mindegy vele, vagy nélküle: a Python ugyanazokat az eredményeket fogja megjeleníteni.
A legtöbb esetben a # (hash tag) – os megjegyzéssel fogsz találkozni, ezt talán sűrűbben használják. Viszont a “”” “”” Docsstring megjegyzéseket is használhatjuk ezzel párhuzamosan, pl. blokkok váltásakor.
Nincs szigorú szabály vagy megkötés arra vonatkozóan, hogy egy kódban hány megjegyzés szerepelhet, illetve milyen hosszúak lehetnek. Szabad teret ad arra, hogy átgondoljuk, hogy hol és milyen terjedelmű megjegyzés szükséges az áttekintésre olyan személynek, aki először találkozik a projektünkkel.
De ahogyan fentebb is szó volt róla, a megjegyzések hasznosak lehetnek saját magunk számára is, hogy később visszatérve hamarabb átláthassuk a megírt kódunkat.
Ha azonban az a kérdés, hogy hagyjunk-e megjegyzést vagy sem, általában hagyjunk egyet legalább a fontosabb kódrészletek előtt. A nagy mennyiségű kódot tartalmazó projekten végzett munka során bevált módszer az, hogy minden jelentős váltáskor vagy új funkció kezdetekor megjegyzést fűzünk hozzá. Ezzel láthatóvá tesszük, hogy valami “új dolog” veszi kezdetét, vagy mit csinál a programunk a következő lépésben.
Ha a későbbiekben probléma merülne fel, vagy a program továbbfejlesztésre kerülne: megoldásaink során hasznos lehet, ha a megjegyzéseinkben minél részletesebb megközelítést adunk, illetve a legegyértelműbb módon fejezzünk ki magunkat.
Inkább legyen az a probléma, hogy túl sok a megjegyzés. Ezeket egyszerűen később könnyen ki lehet törölni, el lehet távolítani a sorok közül. Ellenkező esetben, ha egy szegényes megjegyzéseket tartalmazó program fejlesztése lezárult és később elfelejtjük, hogyan működik: újból átlátni egy komplex programot hosszabb időbe is telhet.
🧠 II. ÁTTEKINTÉS
Ebben a fejezetben a Python kód sorban elhelyezett megjegyzésekkel foglalkoztunk. Láttuk, hogy a megjegyzések milyen hasznosak lehetnek a programozó gondolkodási folyamatainak megjelenítésében, problémák megoldási-folyamatainak ismertetésében.
✍️ III. HÁZI FELADAT
Egészítsd ki megjegyzésekkel az előző fejezetben már végrehajtott gyakorló feladatot. A szükséges helyeken kommentelj, írd le minél részletesebben a céljaidat, feladat megoldására törekvő gondolatmeneted.
Emlékeztetőül a korábban már megoldott feladat:
A munkaadód azt kéri, hogy írj az ügyfelei részére személyre szabott jókívánságokat születésnapjuk alkalmából. A neveknek és az életkoruknak hozz létre külön változókat, majd egy általad megfogalmazott jókívánsággal írasd ki az egész mondatokat a konzolban.
1. András 39 éves
2. Judit 42 éves
3. Gery 24 éves
Fontos!
A feladatok a gyakorlásra vannak. A gyakorlással pedig tapasztalatot szerzel. Mindenképp javasolt, hogy a feladatokat önállóan oldd meg. Javaslom, hogy ha végeztél, csak akkor nézz rá a megoldásra. Erősen ajánlott, hogy előtte mindenképp szánj rá időt és próbáld önállóan végiggondolni, hogy mit is kellene és hogyan lehetséges megvalósítani.
MEGOLDÁSOK (MEGJEGYZÉSEK ELHELYEZÉSE A KÓDBAN)
A videóban bemutatott feladat:
""" Változók létrehozása """
customer_1_name = "András" # Név
customer_1_age = 39 # Életkor
customer_2_name = "Judit" # Név
customer_2_age = 42 # Életkor
customer_3_name = "Gery" # Név
customer_3_age = 24 # Életkor
""" Szöveges karakterlánc (string) kombinálása szám (integer) értékkel """
# "customer_1", "customer_2", "customer_3" nevének és életkorának kiíratása
print("Boldog" + " " + str(customer_1_age) + ". születésnapot kívánunk" + ", " + customer_1_name + "!")
print("Isten éltessen" + " " + customer_2_name + ", " + str(customer_2_age) + ". születésnapod alkalmából szeretettel gratulálunk!")
print("Kedves " + customer_3_name + "! Ma lettél " + str(customer_3_age) + " éves, Boldog szülinapot kívánunk a csapatunk nevében!")
Output:
Boldog 39. születésnapot kívánunk, András!
Isten éltessen Judit, 42. születésnapod alkalmából szeretettel gratulálunk!
Kedves Gery! Ma lettél 24 éves, Boldog szülinapot kívánunk a csapatunk nevében!
V. VISSZAJELZÉS
➡️ Mennyire volt érthető a mai lecke?
Segítsd kérlek a munkánkat, hogy a jövőben még hasznosabb tartalmakat tudjunk készíteni és fejlődhessünk. A visszajelzés teljesen anonym, nincs szükség sem az e-mail címedre, sem a személyes adataidra. A kérdőív kitöltése csak 1 percet vesz igénybe.
Köszönöm, ha rászánsz egy percet – minden visszajelzés segít, hogy még érthetőbb anyagot formálhassak. 🙏
Köszönöm szépen a figyelmedet a Python mini kurzusban!
Őszintén remélem, hogy hasznosnak találtad az anyagokat. Kérlek, ne felejts el írni visszajelzést!
Üdv:
Mészáros Csaba
PythonProject.hu
“Tanulj meg Pythonban gondolkodni – lépésről lépésre.”