2. Opció: a Multi-line Húrok hozzászólás
egy Másik lehetőség írni, hogy “megfelelő” többsoros megjegyzéseket Python, hogy használja a multi-line szálat a """
szintaxis kreatív módon. Íme egy példa:
"""This is a "block comment" in Python, madeout of a mult-line string constant.This actually works quite well!"""answer = 42
mint látható, hármas idézésű karakterláncokkal hozhat létre valamit, ami hasonlít egy többsoros megjegyzésre a Python-ban., Csak meg kell győződnie arról, hogy helyesen behúzta-e az első """
– ot, különben SyntaxError
– t kap. Például, ha egy függvényen belül egy blokk megjegyzést szeretne meghatározni ezzel a technikával, akkor ezt így kell tennie:
csak ne feledje, hogy ez a technika nem hoz létre “igaz” megjegyzéseket. Ez egyszerűen beszúr egy szöveget állandó, hogy nem csinál semmit. Ugyanaz, mint egy normál egysoros karakterlánc beillesztése a kódba, és soha nem fér hozzá.,
azonban egy ilyen árva karakterlánc állandó nem jelenik meg a bájtkódban, hatékonyan többsoros megjegyzéssé alakítva. Itt van bizonyíték arra, hogy a fel nem használt karakterlánc nem jelenik meg a cpython bytecode szétszerelés:
azonban legyen óvatos, ha ezeket a “megjegyzéseket” a kódba helyezi., Ha a string következik, miután egy funkció aláírás, egy osztály meghatározása, vagy a start modul, átalakul egy docstring, amely más a jelentése teljesen Python:
Docstrings (“dokumentáció húrok”) megengedik, hogy a társult olvasható dokumentáció a Python modulok, funkciók, osztályok, illetve módszerek. Ezek különböznek a forráskód megjegyzéseitől:
egy megjegyzést eltávolít az elemző, míg egy docstring a bájtkódba kerül, és a dokumentált objektumhoz kapcsolódik. Még programozottan is elérhető futási időben.,
mint korábban említettem, az egyetlen módja annak, hogy “igaz” többsoros megjegyzéseket kapjunk a Python-ban, amelyeket az elemző figyelmen kívül hagy, több egysoros megjegyzés használata.
bevallom, kissé meglepődtem, hogy ezt a” hamis ” blokk kommentálási stílusát Guido van Rossum, a Python alkotója hagyta jóvá: