Optie 2: meerregelige Strings gebruiken als commentaar

een andere optie voor het schrijven van “proper” meerregelige opmerkingen in Python is om meerregelige strings te gebruiken met de """ syntaxis op creatieve manieren. Hier is een voorbeeld:

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

zoals u kunt zien, kunt u Triple-quoted strings gebruiken om iets te maken dat lijkt op een meerregelige opmerking in Python., Je moet er alleen voor zorgen dat je de eerste """ correct inspringt, anders krijg je een SyntaxError. Als je bijvoorbeeld een blokcommentaar in een functie wilt definiëren met deze techniek, moet je het als volgt doen:

houd er rekening mee dat deze techniek geen “echte” commentaren creëert. Dit voegt gewoon een tekstconstante in die niets doet. Het is hetzelfde als het invoegen van een gewone single-line string ergens in uw code en nooit toegang tot het.,

echter, een dergelijke verweesde stringconstante zal niet worden weergegeven in de bytecode, waardoor het effectief wordt omgezet in een multi-line commentaar. Hier is het bewijs dat de ongebruikte string niet zal verschijnen in de cpython bytecode disassembly:

echter, wees voorzichtig waar je deze “opmerkingen” in de code plaatst., Als de tekenreeks volgt direct na een functiehandtekening, een klasse definitie, of aan het begin van een module, verandert het in een docstring die een andere betekenis heeft in Python:

met Docstrings (“documentation strings”) kun je voor mensen leesbare documentatie associëren met Python modules, functies, klassen en methoden. Ze zijn verschillend van broncode opmerkingen:

een commentaar wordt verwijderd door de parser, terwijl een docstring eindigt in de bytecode en wordt geassocieerd met het gedocumenteerde object. Het kan zelfs programmatisch worden benaderd tijdens runtime.,

zoals ik al eerder zei, de enige manier om “true” multi-line commentaren in Python te krijgen die genegeerd worden door de parser is door meerdere # single-line commentaren te gebruiken.

Ik geef toe dat ik enigszins verrast was toen ik ontdekte dat deze “nep” blokcommentaarstijl werd onderschreven door Guido Van Rossum, de maker van Python: