Is er een mechanisme om commentaar te leveren op grote blokken Python-code?
Op dit moment is de enige manier waarop ik kan zien dat ik commentaar kan geven op code, is om elke regel te beginnen met een #, of om de code tussen drievoudige aanhalingstekens te plaatsen: """.
Het probleem hiermee is dat het invoegen van # voor elke regel omslachtig is en """ ervoor zorgt dat de string die ik als commentaar wil gebruiken in gegenereerde documentatie verschijnt.
Na het lezen van alle reacties lijkt het antwoord “Nee” te zijn.
Antwoord 1, autoriteit 100%
Python heeft zo’n mechanisme niet. Voeg een # toe aan elke regel om commentaar te blokkeren. Zie PEP 8 voor meer informatie. De meeste Python IDE’s ondersteunen een mechanisme om het blok-commentaar-met-hekje-tekens automatisch voor je uit te voeren. In IDLE op mijn computer is dit bijvoorbeeld Alt+3 en Alt+4.
Gebruik geen driedubbele aanhalingstekens; zoals je hebt ontdekt, is dit voor documentatiereeksen die geen opmerkingen blokkeren, hoewel het een soortgelijk effect heeft. Als je dingen gewoon tijdelijk uitspreekt, is dit prima als tijdelijke maatregel.
Antwoord 2, autoriteit 21%
De enige remedie die ik hiervoor ken, is een goede editor. Sorry.
Antwoord 3, autoriteit 20%
Verberg de drievoudige aanhalingstekens in een context die niet zal worden aangezien voor een docstring, bijvoorbeeld:
'''
...statements...
''' and None
of:
if False: '''
...statements...
'''
Antwoord 4, autoriteit 10%
De enige manier waarop u dit kunt doen zonder driedubbele aanhalingstekens is door een:
. toe te voegen
if False:
En laat dan al je code inspringen. Merk op dat de code nog steeds de juiste syntaxis moet hebben.
Veel Python IDE’s kunnen # voor je toevoegen aan elke geselecteerde regel, en ze ook verwijderen als ze commentaar verwijderen. Evenzo, als u vi of Emacs je kunt een macro maken om dit voor je te doen voor een codeblok.
Antwoord 5, autoriteit 8%
Gebruik in JetBrains PyCharm op Mac Command + / om commentaar te geven op geselecteerd codeblok of om commentaar op te heffen. Gebruik in Windows CTRL + /.
Antwoord 6, autoriteit 6%
M-x comment-regio, in Emacs‘ Python-modus.
Antwoord 7, autoriteit 4%
Ten minste in VIM kun je de eerste tekstkolom selecteren die je wilt invoegen met de Block Visual-modus (CTRL+V in niet-windows VIM’s) en dan een # voor elke regel met deze reeks:
I#<esc>
In Block Visual-modus gaat I naar de invoegmodus met de cursor voor het blok op de eerste regel. De ingevoegde tekst wordt vóór elke regel in het blok gekopieerd.
Antwoord 8, autoriteit 2%
comm='''
Junk, or working code
that I need to comment.
'''
Je kunt comm vervangen door een variabele naar keuze die misschien korter is, makkelijk aan te raken is en waarvan je weet dat die niet (en ook niet) voorkomt in je programma’s. Voorbeelden: xxx, oo, null, nil.
Antwoord 9, autoriteit 2%
In vi:
- Ga naar de bovenkant van het blok en markeer het met de letter a.
- Ga naar de onderkant van het blok en markeer het met de letter b
Doe dan
:'a,'b s!^!#!
Antwoord 10
In Visual Studio met behulp van de Python Tools for Visual Studio, kunnen blokken worden becommentarieerd door Ctrl +K, Ctrl+C en zonder commentaar door Ctrl+K, Ctrl+U.
Antwoord 11
Ja, die is er (afhankelijk van je editor). In PyDev (en in Aptana Studio met PyDev):
-
Ctrl + 4 – commentaar op geselecteerd blok
-
Ctrl + 5 – verwijder commentaar bij geselecteerd blok
Antwoord 12
Ik gebruik Notepad++ op een Windows-computer, selecteer uw code, typ CTRL-K. Om commentaar te verwijderen, selecteert u code en drukt u op Ctrl + Shift + K.
Overigens werkt Notepad++ prima als Python-editor. Met automatisch aanvullen, codevouwen, syntaxisaccentuering en nog veel meer. En het is vrij als in spraak en als in bier!
Antwoord 13
In Eclipse + PyDev, Python-blokcommentaar is vergelijkbaar met Eclipse Java-blokcommentaar; selecteer de regels die je wilt becommentariëren en gebruik Ctrl + / om commentaar te geven. Om een commentaar op een blok met commentaar ongedaan te maken, doe je hetzelfde.
Antwoord 14
Het enige mechanisme om Python-code te becommentariëren (begrepen als code die door de tolk wordt genegeerd) is de #.
Zoals je zegt, kun je ook tekenreeksletters gebruiken, die niet worden genegeerd door de interpreter, maar volledig irrelevant kunnen zijn voor de uitvoering van het programma.
Antwoord 15
In Eclipse met behulp van PyDev, je kunt een codeblok selecteren en op Ctrl + # drukken.
Antwoord 16
Drievoudige aanhalingstekens zijn oké voor mij.
U kunt ”’ foo ”’ gebruiken voor docstrings en “”” bar “”” voor opmerkingen of vice versa om de code leesbaarder te maken.
Antwoord 17
Een andere op een editor gebaseerde oplossing: tekst “rechthoeken” in Emacs.
Markeer de code die u wilt verwijderen en vervolgens C-x-r-t #
Om commentaar op de code ongedaan te maken: markeer, dan C-x-r-k
Ik gebruik dit de hele dag, elke dag. (Uiteraard toegewezen aan sneltoetsen.)
Deze en krachtige regex zoeken/vervangen is de reden dat ik de andere “excentriciteiten” van Emacs tolereer.
Antwoord 18
Op Eric4 is er een gemakkelijke manier: selecteer een blok, typ Ctrl+M om het hele blok te becommentariëren of Ctrl+alt+M om commentaar ongedaan te maken.
Antwoord 19
Gebruik een mooie editor zoals SciTe, selecteer je code, druk op Ctrl< /kbd> + Q en klaar.
Als je geen editor hebt die blokopmerkingen ondersteunt, kun je een driedubbele tekenreeks tussen aanhalingstekens aan het begin en het einde van je codeblok gebruiken om er 'effectief' commentaar op te geven. Het is echter niet de beste methode.