Python Multi-linie Comentarii: cele mai Bune Două Opțiuni


Opțiunea 2: Folosind Multi-linie Siruri de caractere fel de Comentarii

o Altă opțiune pentru scris „buna” multi-linie comentarii în Python este de a folosi multi-linie de siruri de caractere cu """ sintaxa în moduri creative. Iată un exemplu:

"""This is a "block comment" in Python, madeout of a mult-line string constant.This actually works quite well!"""answer = 42

după cum puteți vedea, puteți utiliza șiruri triple-citate pentru a crea ceva care seamănă cu un comentariu multilinie în Python., Trebuie doar să vă asigurați că Indentați corect primul """, altfel veți obține un SyntaxError. De exemplu, dacă doriți să definiți un comentariu bloc în interiorul unei funcții cu această tehnică, trebuie să o faceți astfel:

rețineți că această tehnică nu creează comentarii „adevărate”. Aceasta introduce pur și simplu o constantă de text care nu face nimic. Este la fel ca introducerea unui șir obișnuit de o singură linie undeva în codul dvs. și niciodată accesarea acestuia.,

cu toate acestea, o astfel de constantă de șir orfan nu va apărea în codul bytecode, transformându-l efectiv într-un comentariu cu mai multe linii. Iată dovada că șirul neutilizat nu va apărea în dezasamblarea Codului bytecode CPython:

cu toate acestea, aveți grijă unde plasați aceste „comentarii” în cod., Dacă șirul cum urmează imediat după o funcție semnătura, definitia clasei, sau la începutul unui modul, acesta se transformă într-un docstring care are o altă semnificație cu totul în Python:

Docstrings („documentația de siruri de caractere”) să vă asociați-uman poate fi citit documentația cu Python module, funcții, clase și metode. Ele sunt diferite de comentariile codului sursă:

un comentariu este eliminat de analizor, în timp ce un docstring ajunge în codul bytecode și este asociat cu obiectul documentat. Acesta poate fi accesat chiar programatic în timpul rulării.,

așa cum am spus mai devreme, singura modalitate de a obține comentarii „true” cu mai multe linii în Python care sunt ignorate de parser este să folosești mai multe # comentarii cu o singură linie.

recunosc că am fost ușor surprins să găsesc acest stil de comentare „fals” a fost aprobat de Guido van Rossum, creatorul Python:

Lasă un răspuns

Adresa ta de email nu va fi publicată. Câmpurile obligatorii sunt marcate cu *