Gibt es eine Möglichkeit, mehrzeilige Kommentare in Python zu erstellen?

Ich habe vor kurzem angefangen, Python zu studieren , konnte aber keine mehrzeiligen Kommentare implementieren. Die meisten Sprachen haben Blockkommentarsymbole wie

/*

*/

Ich habe dies in Python versucht, aber es wird ein Fehler ausgegeben, daher ist dies wahrscheinlich nicht der richtige Weg. Hat Python tatsächlich eine mehrzeilige Kommentarfunktion?

Sie können Zeichenfolgen in dreifachen Anführungszeichen verwenden. Wenn sie keine Dokumentzeichenfolge sind (das erste in einer Klasse / Funktion / einem Modul), werden sie ignoriert.

'''
This is a multiline
comment.
'''

(Stellen Sie sicher, dass die Führung '''entsprechend eingerückt ist , um eine IndentationError.)

Guido van Rossum (Schöpfer von Python) hat dies als "Pro-Tipp" getwittert .

Der Python-Styleguide PEP8 bevorzugt jedoch die Verwendung aufeinanderfolgender einzeiliger Kommentare , und dies finden Sie auch in vielen Projekten. Texteditoren haben normalerweise eine Verknüpfung, um dies einfach zu tun.

Python verfügt über eine mehrzeilige Zeichenfolgen- / Kommentarsyntax in dem Sinne, dass mehrzeilige Zeichenfolgen , sofern sie nicht als Dokumentzeichenfolgen verwendet werden, keinen Bytecode generieren - genau wie #vorangestellte Kommentare. Tatsächlich verhält es sich genau wie ein Kommentar.

Wenn Sie andererseits sagen, dass dieses Verhalten in der offiziellen Dokumentation dokumentiert werden muss, um eine echte Kommentarsyntax zu sein, dann können Sie zu Recht sagen, dass es als Teil der Sprachspezifikation nicht garantiert ist.

In jedem Fall sollte Ihr Texteditor auch in der Lage sein, einen ausgewählten Bereich einfach auskommentieren zu können (indem Sie #vor jeder Zeile ein einzelnes platzieren). Wenn nicht, wechseln Sie zu einem Texteditor, der dies tut.

Das Programmieren in Python ohne bestimmte Textbearbeitungsfunktionen kann eine schmerzhafte Erfahrung sein. Das Finden des richtigen Editors (und das Wissen, wie man ihn verwendet) kann einen großen Unterschied in der Wahrnehmung der Python-Programmiererfahrung bewirken.

Der Texteditor sollte nicht nur ausgewählte Bereiche auskommentieren können, sondern auch Codeblöcke leicht nach links und rechts verschieben können, und er sollte den Cursor beim Drücken automatisch auf die aktuelle Einrückungsstufe setzen Enter. Das Falten von Code kann ebenfalls nützlich sein.

Zum Schutz vor dem Verfall von Links ist hier der Inhalt von Guido van Rossums Tweet :

@BSUCSClub Python-Tipp: Sie können mehrzeilige Zeichenfolgen als mehrzeilige Kommentare verwenden. Sofern sie nicht als Dokumentzeichenfolgen verwendet werden, generieren sie keinen Code! :-)

Aus der akzeptierten Antwort ...

Sie können Zeichenfolgen in dreifachen Anführungszeichen verwenden. Wenn sie keine Dokumentzeichenfolge sind (als erstes in einer Klasse / Funktion / einem Modul), werden sie ignoriert.

Das ist einfach nicht wahr. Im Gegensatz zu Kommentaren werden Zeichenfolgen in dreifachen Anführungszeichen weiterhin analysiert und müssen syntaktisch gültig sein, unabhängig davon, wo sie im Quellcode erscheinen.

Wenn Sie versuchen, diesen Code auszuführen ...

def parse_token(token):
    """
    This function parses a token.
    TODO: write a decent docstring :-)
    """

    if token == '\\and':
        do_something()

    elif token == '\\or':
        do_something_else()

    elif token == '\\xor':
        '''
        Note that we still need to provide support for the deprecated
        token \xor. Hopefully we can drop support in libfoo 2.0.
        '''
        do_a_different_thing()

    else:
        raise ValueError

Sie werden entweder ...

ValueError: invalid \x escape

... auf Python 2.x oder ...

SyntaxError: (unicode error) 'unicodeescape' codec can't decode bytes in position 79-80: truncated \xXX escape

... auf Python 3.x.

Die einzige Möglichkeit, mehrzeilige Kommentare zu erstellen, die vom Parser ignoriert werden, ist ...

elif token == '\\xor':
    # Note that we still need to provide support for the deprecated
    # token \xor. Hopefully we can drop support in libfoo 2.0.
    do_a_different_thing()

In Python 2.7 lautet der mehrzeilige Kommentar:

"""
This is a
multilline comment
"""

Wenn Sie sich in einer Klasse befinden, sollten Sie sie ordnungsgemäß tabulieren.

Zum Beispiel:

class weather2():
   """
   def getStatus_code(self, url):
       world.url = url
       result = requests.get(url)
       return result.status_code
   """

AFAIK, Python hat keine Blockkommentare. Zum Kommentieren einzelner Zeilen können Sie das #Zeichen verwenden.

Wenn Sie Notepad ++ verwenden , gibt es eine Verknüpfung zum Blockkommentieren . Ich bin sicher, dass andere wie gVim und Emacs ähnliche Funktionen haben.

Ich denke nicht, außer dass eine mehrzeilige Zeichenfolge nicht verarbeitet wird. Die meisten, wenn nicht alle Python-IDEs verfügen jedoch über eine Tastenkombination zum Auskommentieren mehrerer Codezeilen.

Wenn Sie einen Kommentar eingeben

"""
long comment here
"""

In der Mitte eines Skripts erkennen Python / Linters das nicht. Das Zusammenklappen wird durcheinander gebracht, da der obige Kommentar nicht Teil der Standardempfehlungen ist. Es ist besser zu benutzen

# Long comment
# here.

Wenn Sie Vim verwenden , können Sie Plugins wie comment.vim verwenden , um lange Kommentarzeilen automatisch durch Drücken von zu kommentieren Vjgcc. Wo Vjwählt zwei Codezeilen, undgcc Kommentare sie aus.

Wenn Sie keine Plugins wie die oben genannten verwenden möchten, können Sie Suchen und Ersetzen wie verwenden

:.,.+1s/^/# /g

Dies ersetzt das erste Zeichen in der aktuellen und nächsten Zeile durch #.

Es gibt keine Funktion wie einen mehrzeiligen Kommentar. #ist die einzige Möglichkeit, eine einzelne Codezeile zu kommentieren. Viele von Ihnen antworteten auf einen Kommentar als Lösung.

Es scheint zu funktionieren, aber intern '''in Python werden die Zeilen als reguläre Zeichenfolgen eingeschlossen, die der Interpreter nicht ignoriert, wie Kommentare mit #.

Überprüfen Sie die offizielle Dokumentation hier

Leider kann die Stringifizierung nicht immer als Kommentar verwendet werden! Es ist also sicherer, sich an den Standard zu halten, bei dem jeder Zeile ein vorangestellt wird# .

Hier ist ein Beispiel:

test1 = [1, 2, 3, 4,]       # test1 contains 4 integers

test2 = [1, 2, '''3, 4,'''] # test2 contains 2 integers **and the string** '3, 4,'

Nun, Sie können dies versuchen (wenn Sie das Zitat ausführen, sollte die Eingabe für die erste Frage mit zitiert werden '):

"""
print("What's your name? ")
myName = input()
print("It's nice to meet you " + myName)
print("Number of characters is ")
print(len(myName))
age = input("What's your age? ")
print("You will be " + str(int(age)+1) + " next year.")

"""
a = input()
print(a)
print(a*5)

Was auch immer dazwischen eingeschlossen ist, """wird kommentiert.

Wenn Sie nach einzeiligen Kommentaren suchen, dann ist es #.

Mehrzeiliger Kommentar in Python:

Bei mir haben sowohl '' 'als auch "" funktioniert.

Beispiel:

a = 10
b = 20
c = a+b
'''
print ('hello')
'''
print ('Addition is: ', a+b)

Beispiel:

a = 10
b = 20
c = a+b
"""
print('hello')
"""
print('Addition is: ', a+b)

Die Inline-Kommentare in Python beginnen mit einem Hash-Zeichen.

hello = "Hello!" # This is an inline comment
print(hello)

Hallo!

Beachten Sie, dass ein Hash-Zeichen in einem String-Literal nur ein Hash-Zeichen ist.

dial = "Dial #100 to make an emergency call."
print(dial)

Wählen Sie # 100, um einen Notruf zu tätigen.

Ein Hash-Zeichen kann auch für ein- oder mehrzeilige Kommentare verwendet werden.

hello = "Hello"
world = "World"
# First print hello
# And print world
print(hello)
print(world)

Hallo

Welt

Schließen Sie den Text in dreifache doppelte Anführungszeichen ein, um die Dokumentzeichenfolge zu unterstützen.

def say_hello(name):
    """
    This is docstring comment and
    it's support multi line.
    :param name it's your name
    :type name str
    """
    return "Hello " + name + '!'


print(say_hello("John"))

Hallo John!

Schließen Sie den Text in dreifache einfache Anführungszeichen für Blockkommentare ein.

'''
I don't care the parameters and
docstrings here.
'''

Unter Python 2.7.13:

Single:

"A sample single line comment "

Mehrzeilig:

"""
A sample
multiline comment
on PyCharm
"""

Visual Studio Code universeller offizieller mehrzeiliger Kommentarumschalter.

macOS: Wählen Sie Codeblock und dann ⌘+/

Windows: Wählen Sie Codeblock und dann Ctrl+/

Ja, es ist in Ordnung, beide zu verwenden:

'''
Comments
'''

und

"""
Comments
"""

Das einzige, woran Sie sich alle erinnern müssen, wenn Sie in einer IDE ausgeführt werden, ist, dass Sie die gesamte Datei "LAUFEN" müssen, um als Mehrzeilencode akzeptiert zu werden. Zeile für Zeile 'RUN' funktioniert nicht richtig und zeigt einen Fehler an.

Zum Auskommentieren mehrerer Codezeilen in Python verwenden Sie einfach einen #einzeiligen Kommentar in jeder Zeile:

# This is comment 1
# This is comment 2 
# This is comment 3

Um „richtige“ mehrzeilige Kommentare in Python zu schreiben, müssen mehrzeilige Zeichenfolgen mit der """Syntax verwendet werden. Python verfügt über die Funktion für Dokumentationszeichenfolgen (oder Dokumentzeichenfolgen). Es bietet Programmierern eine einfache Möglichkeit, mit jedem Python-Modul, jeder Funktion, Klasse und Methode schnelle Notizen hinzuzufügen.

'''
This is
multiline
comment
'''

Erwähnen Sie außerdem, dass Sie über ein Klassenobjekt wie dieses auf docstring zugreifen können

myobj.__doc__

Sie können Folgendes verwenden. Dies wird als DockString bezeichnet.

def my_function(arg1):
    """
    Summary line.
    Extended description of function.
    Parameters:
    arg1 (int): Description of arg1
    Returns:
    int: Description of return value
    """
    return arg1

print my_function.__doc__

Ich würde davon abraten, """mehrzeilige Kommentare zu verwenden!

Hier ist ein einfaches Beispiel, um hervorzuheben, was als unerwartetes Verhalten angesehen werden kann:

print('{}\n{}'.format(
    'I am a string',
    """
    Some people consider me a
    multi-line comment, but
    """
    'clearly I am also a string'
    )
)

Schauen Sie sich jetzt die Ausgabe an:

I am a string

    Some people consider me a
    multi-line comment, but
    clearly I am also a string

Die mehrzeilige Zeichenfolge wurde nicht als Kommentar behandelt, sondern mit 'clearly I'm also a string'einer einzelnen Zeichenfolge verknüpft.

Wenn Sie mehrere Zeilen kommentieren möchten, tun Sie dies gemäß den PEP 8- Richtlinien :

print('{}\n{}'.format(
    'I am a string',
    # Some people consider me a
    # multi-line comment, but
    'clearly I am also a string'
    )
)

Ausgabe:

I am a string
clearly I am also a string

Verwenden der PyCharm-IDE.

Sie können commentund uncommentCodezeilen mit Strg + /. Strg + / kommentiert oder kommentiert die aktuelle Zeile oder mehrere ausgewählte Zeilen mit einzeiligen Kommentaren ({# in Django templates, or # in Python scripts). Pressing Ctrl+Shift+/Für einen ausgewählten Quellcodeblock in einer Django-Vorlage wird der Block mit {% comment %} and {% endcomment %}Tags umgeben.

---

n = 5
while n > 0:
    n -= 1
    if n == 2:
        break
    print(n)

print("Loop ended.")

Wählen Sie alle Zeilen aus und drücken Sie Ctrl + /

# n = 5
# while n > 0:
#     n -= 1
#     if n == 2:
#         break
#     print(n)

# print("Loop ended.")

Ein mehrzeiliger Kommentar ist in Python nicht vorhanden. Das folgende Beispiel besteht aus einer nicht zugewiesenen Zeichenfolge, die von Python auf syntaktische Fehler überprüft wird.

Einige Texteditoren wie Notepad ++ bieten Verknüpfungen zum Auskommentieren eines geschriebenen Codes oder von Wörtern.

def foo():
    "This is a doc string."
    # A single line comment
    """
       This
       is a multiline
       comment/String
    """
    """
    print "This is a sample foo function"
    print "This function has no arguments"
    """
    return True

Außerdem ist Ctrl+ Keine Verknüpfung in Notepad ++, um Kommentare zu blockieren. Es wird #vor jeder Zeile unter der Auswahl ein eingefügt. Ctrl+ Shift+ KIst für Block uncomment.

Unter anderem finde ich es am einfachsten, die IDE-Kommentarfunktionen zu verwenden, die die Python-Kommentarunterstützung von verwenden #.

Ich benutze Anaconda Spyder und es hat:

• Ctrl+ 1- Kommentar / Kommentar
• Ctrl+ 4- Kommentieren Sie einen Codeblock
• Ctrl+ 5- Kommentieren Sie einen Codeblock aus

Es würde eine / mehrere Codezeilen mit / kommentieren / auskommentieren #.

Ich finde es am einfachsten.

Zum Beispiel ein Blockkommentar:

# =============================================================================
#     Sample Commented code in spyder
#  Hello, World!
# =============================================================================

Wählen Sie die Zeilen aus, die Sie kommentieren möchten, und kommentieren oder kommentieren Sie den Python-Code im Sublime Text- Editor mit Ctrl+ .?

Für eine einzelne Zeile können Sie Shift+ verwenden #.