Ebben az oktatóanyagban megtanulunk hozzászólásokat létrehozni a Pythonban példák segítségével.
Videó: Megjegyzések a Pythonban
A megjegyzések olyan leírások, amelyek segítenek a programozóknak jobban megérteni a program szándékát és funkcionalitását.
A Python tolmács teljesen figyelmen kívül hagyja őket.
A megjegyzések használatának előnyei
A megjegyzések használata a programokban érthetőbbé teszi kódunkat. Ez olvashatóbbá teszi a programot, ami segít emlékezni arra, hogy miért írtak bizonyos kódblokat.
Ezen kívül a megjegyzések felhasználhatók bizonyos kódok figyelmen kívül hagyására más kódblokkok tesztelése közben. Ez egyszerű módot kínál néhány sor végrehajtásának megakadályozására, vagy gyors álkódot írhat a programhoz.
Egysoros megjegyzések Pythonban
A Pythonban a hash szimbólumot használjuk #egysoros megjegyzés írásához.
1. példa: Egysoros megjegyzések írása
# printing a string print('Hello world')
Kimenet
Helló Világ
Itt van a megjegyzés:
# printing a string
Ezt a sort a Python tolmács figyelmen kívül hagyja.
Mindent #figyelmen kívül hagynak , ami utána következik. Tehát a fenti programot egyetlen sorba is felírhatjuk:
print('Hello world') #printing a string
Ennek a programnak a kimenete ugyanaz lesz, mint az 1. példában . A tolmács figyelmen kívül hagyja az összes szöveget #.
Többsoros megjegyzések Pythonban
A Python nem kínál külön módot többsoros megjegyzések írására. Vannak azonban más módszerek is a probléma kiküszöbölésére.
#Minden megjegyzéssor elején használhatunk több sort.
2. példa: Több # használata
# it is a # multiline # comment
Itt minden sort egyetlen megjegyzésként kezelünk, és mindegyiket figyelmen kívül hagyjuk.
Karakterláncok többsoros megjegyzésekhez
Annak ellenére, hogy nincs egyedi módja a többsoros megjegyzések írásának a Pythonban, tudjuk, hogy a Python tolmács figyelmen kívül hagyja azokat a karakterlánc-literálokat, amelyek nincsenek hozzárendelve egy változóhoz.
Tehát akár egysoros megjegyzést is írhatunk:
#this is a comment 'this is an unassigned string as a comment '
Itt láthatjuk, hogy a program második sora egy karakterlánc, de nincs hozzárendelve egyetlen változóhoz vagy függvényhez sem. Tehát a tolmács figyelmen kívül hagyja a karakterláncot.
Hasonló módon többsoros karakterláncokat (hármas idézőjeleket) használhatunk többsoros megjegyzések írására.
Az idézőjel lehet 'vagy ".
3. példa: Karakterláncok használata többsoros megjegyzések írására
''' I am a multiline comment! ''' print("Hello World")
Itt a többsoros karakterlánc nincs hozzárendelve egyetlen változóhoz sem, ezért a tolmács figyelmen kívül hagyja. Annak ellenére, hogy ez technikailag nem többsoros megjegyzés, egyként is használható.
Python-utasítások
Megállapodás szerint a függvény, a módszer vagy az osztálydefiníció után közvetlenül megjelenő hármas idézetek docstringek (dokumentációs karakterláncok).
A parancssorok objektumokhoz vannak társítva, és az __doc__attribútummal érhetők el .
További információkért keresse fel a Python-parancssort.
Hogyan lehet jobb megjegyzéseket írni?
- Használja a megjegyzéseket annak leírására, hogy egy funkció mit csinál, és ne a funkció részleteinek részletes leírását.
- Próbáljon meg minél több felesleges megjegyzést eltávolítani. Próbáljon meg olyan kódot írni, amely meg tudja magyarázni, jobb funkció / változó névválasztással.
- Próbálja meg a lehető legrövidebb és tömörebb megjegyzéseket tenni.
