Python Multi-line Kommentarer: Din Bedste Valg


Mulighed 2: Brug af Multi-line Strenge som Kommentarer

en Anden mulighed for at skrive “rigtige” multi-line kommentarer i Python er at bruge multi-line strengene med """ syntaks på kreative måder. Her er et eksempel:

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

Som du kan se, kan du bruge triple-børsnoterede strygere til at skabe noget, der ligner en multiline kommentar i Python., Du skal bare sørge for, at du indrykker den første """ korrekt, ellers får du en SyntaxError. For eksempel, hvis du gerne vil definere en blokkommentar inde i en funktion med denne teknik, skal du gøre det sådan:

bare husk, at denne teknik ikke skaber “sande” kommentarer. Dette indsætter blot en tekstkonstant, der ikke gør noget. Det er det samme som at indsætte en almindelig enkeltlinjestreng et eller andet sted i din kode og aldrig få adgang til den.,

en sådan forældreløs strengkonstant vises dog ikke i bytekoden, hvilket effektivt gør den til en multi-line kommentar. Her er bevis på, at den ubrugte streng ikke vises i CPython bytecode-demontering:

Vær dog forsigtig, hvor du placerer disse “kommentarer” i koden., Hvis den streng, der følger lige efter en funktion signatur, en klasse-definition, eller i starten af et modul, det bliver til en docstring, som har en anden mening helt i Python:

Dokumentationsstrenge (“dokumentation strenge”) lad du forbinder menneske-læsbart dokumentation for Python-moduler, funktioner, klasser og metoder. De er forskellige fra kildekode kommentarer:

en kommentar fjernes af parseren, mens en docstring ender i bytekoden og er forbundet med det dokumenterede objekt. Det kan endda tilgås programmatisk ved runtime.,

Som jeg sagde tidligere, er den eneste måde at få “ægte” multi-line kommentarer i Python, der bliver ignoreret af parseren er at bruge flere # single-line kommentarer.

Jeg indrømmer, at jeg var lidt overrasket over at finde ud af, at denne” falske ” blokkommentarstil blev godkendt af Guido van Rossum, skaberen af Python:

Skriv et svar

Din e-mailadresse vil ikke blive publiceret. Krævede felter er markeret med *