Czy istnieje sposób tworzenia komentarzy wielowierszowych w Pythonie?

Niedawno zacząłem studiować Python , ale nie mogłem znaleźć sposobu na wdrożenie komentarzy wieloliniowych. Większość języków ma symbole blokowego komentarza, takie jak

/*

*/

Próbowałem tego w Pythonie, ale generuje błąd, więc prawdopodobnie nie jest to właściwy sposób. Czy Python faktycznie posiada funkcję komentowania wielowierszowego?

Możesz użyć potrójnych cudzysłowów. Gdy nie są one dokumentacją (pierwszą rzeczą w klasie / funkcji / module), są ignorowane.

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

(Upewnij się, że odpowiednio wcinasz wiodące, '''aby uniknąć IndentationError.)

Guido van Rossum (twórca Pythona) napisał na Twitterze jako „pro tip”.

Jednak przewodnik po stylu Pythona, PEP8, preferuje stosowanie kolejnych jednowierszowych komentarzy , i to również znajduje się w wielu projektach. Edytory tekstu zwykle mają do tego skrót.

Python ma wielowierszową składnię ciąg / komentarz w tym sensie, że jeśli nie zostanie użyty jako ciąg znaków , ciągi wielowierszowe nie generują kodu bajtowego - podobnie jak #wcześniejsze komentarze. W efekcie działa dokładnie jak komentarz.

Z drugiej strony, jeśli powiesz, że takie zachowanie musi być udokumentowane w oficjalnej dokumentacji, aby było prawdziwą składnią komentarza, to tak, słusznie powiesz, że nie jest to gwarantowane jako część specyfikacji języka.

W każdym razie edytor tekstu powinien mieć również możliwość łatwego komentowania wybranego regionu (umieszczając #przed każdym wierszem osobno). Jeśli nie, przejdź do edytora tekstu, który to robi.

Programowanie w Pythonie bez pewnych funkcji edycji tekstu może być bolesnym doświadczeniem. Znalezienie odpowiedniego edytora (i umiejętność jego używania) może mieć duży wpływ na postrzeganie doświadczenia w programowaniu w języku Python.

Edytor tekstowy powinien nie tylko móc komentować wybrane regiony, ale powinien także móc łatwo przesuwać bloki kodu w lewo i prawo, a także automatycznie ustawiać kursor na bieżącym poziomie wcięcia po naciśnięciu Enter. Przydatne może być również składanie kodu.

Aby zabezpieczyć się przed rozpadem linków, oto treść tweeta Guido van Rossuma :

@BSUCSClub Wskazówka dla Pythona: Możesz używać ciągów wielowierszowych jako komentarzy wielowierszowych. O ile nie są używane jako dokumenty, nie generują kodu! :-)

Z zaakceptowanej odpowiedzi ...

Możesz użyć potrójnych cudzysłowów. Gdy nie są one dokumentacją (pierwszą rzeczą w klasie / funkcji / module), są ignorowane.

To po prostu nieprawda. W przeciwieństwie do komentarzy, ciągi potrójne są nadal analizowane i muszą być poprawne pod względem składniowym, niezależnie od tego, gdzie występują w kodzie źródłowym.

Jeśli spróbujesz uruchomić ten kod ...

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

Dostaniesz albo ...

ValueError: invalid \x escape

... na Python 2.x lub ...

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

... w Pythonie 3.x.

Jedynym sposobem na komentarze wieloliniowe, które są ignorowane przez analizator składni, jest ...

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()

W Pythonie 2.7 komentarzem wielowierszowym jest:

"""
This is a
multilline comment
"""

Jeśli jesteś w klasie, powinieneś ją odpowiednio tabulować.

Na przykład:

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

AFAIK, Python nie ma blokowanych komentarzy. Aby komentować poszczególne linie, możesz użyć #znaku.

Jeśli używasz Notepad ++ , istnieje skrót do komentowania bloków . Jestem pewien, że inni, tacy jak gVim i Emacs, mają podobne funkcje.

Myślę, że tak nie jest, z wyjątkiem tego, że łańcuch wielowierszowy nie jest przetwarzany. Jednak większość, jeśli nie wszystkie środowiska IDE Pythona, mają skrót do komentowania wielu linii kodu.

Jeśli dodasz komentarz

"""
long comment here
"""

w środku skryptu Python / linters tego nie rozpoznają. Składanie zostanie pomieszane, ponieważ powyższy komentarz nie jest częścią standardowych zaleceń. Lepiej jest użyć

# Long comment
# here.

Jeśli używasz Vima , możesz używać wtyczek takich jak commentary.vim , aby automatycznie komentować długie linie komentarzy, naciskając Vjgcc. Gdzie Vjwybiera dwa wiersze kodu i gcckomentuje je.

Jeśli nie chcesz używać wtyczek takich jak powyżej, możesz użyć wyszukiwania i zastąpić podobne

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

Zastąpi to pierwszy znak w bieżącym i następnym wierszu #.

Nie ma takiej funkcji jak komentarz wieloliniowy. #jest jedynym sposobem skomentowania pojedynczej linii kodu. Wielu z was odpowiedziało na ten komentarz jako swoje rozwiązanie.

Wygląda na to, że działa, ale wewnętrznie '''w Pythonie przyjmuje wiersze ujęte w regularne ciągi znaków, których interpreter nie ignoruje przy użyciu komentarzy #.

Sprawdź oficjalną dokumentację tutaj

Niestety, nie zawsze można użyć skreślenia jako komentarza! Dlatego bezpieczniej jest trzymać się standardu, poprzedzając każdą linię znakiem #.

Oto przykład:

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

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

Cóż, możesz wypróbować to (podczas uruchamiania cytowanego wejścia do pierwszego pytania należy zacytować '):

"""
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)

Cokolwiek """będzie zawarte, zostanie skomentowane.

Jeśli szukasz komentarzy jednowierszowych, to jest #.

Komentarz wieloliniowy w Pythonie:

U mnie zarówno „” ”, jak i„ ”„ działały.

Przykład:

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

Przykład:

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

Komentarze wbudowane w Pythonie zaczynają się od znaku skrótu.

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

Dzień dobry!

Zauważ, że znak skrótu w dosłownym ciągu jest po prostu znakiem skrótu.

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

Wybierz # 100, aby wykonać połączenie alarmowe.

Znak skrótu może być również użyty do komentarza w jednym lub w wielu wierszach.

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

Witaj

Świat

Dołącz tekst potrójnymi podwójnymi cudzysłowami w celu obsługi dokumentów.

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"))

Cześć John!

Dołącz tekst potrójnymi pojedynczymi cudzysłowami do komentarzy blokowych.

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

W Pythonie 2.7.13:

Pojedynczy:

"A sample single line comment "

Multiline:

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

Uniwersalny oficjalny wieloliniowy przełącznik komentarzy Visual Studio Code .

macOS: wybierz blok kodu, a następnie ⌘+/

Windows: wybierz blok kodu, a następnie Ctrl+/

Tak, można używać obu:

'''
Comments
'''

i

"""
Comments
"""

Ale jedyną rzeczą, o której wszyscy musicie pamiętać podczas pracy w środowisku IDE, jest „URUCHOMIENIE” całego pliku, aby zaakceptować go jako kody wielu linii. Linia po linii „RUN” nie będzie działać poprawnie i wyświetli błąd.

Aby skomentować wiele wierszy kodu w Pythonie, wystarczy użyć #komentarza jednowierszowego w każdym wierszu:

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

Do pisania „poprawnych” komentarzy wieloliniowych w Pythonie należy używać ciągów wieloliniowych ze """składnią Python ma funkcję ciągów dokumentacji (lub ciągów dokumentów). Daje to programistom łatwy sposób dodawania szybkich notatek do każdego modułu, funkcji, klasy i metody Pythona.

'''
This is
multiline
comment
'''

Wspomnij również, że możesz uzyskać dostęp do dokumentów przez obiekt klasy taki jak ten

myobj.__doc__

Możesz użyć następujących. Nazywa się to DockString.

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__

Odradzam używanie """komentarzy wieloliniowych!

Oto prosty przykład podkreślający to, co można uznać za nieoczekiwane zachowanie:

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

Teraz spójrz na wynik:

I am a string

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

Ciąg wielowierszowy nie był traktowany jako komentarz, ale został połączony z 'clearly I'm also a string'jednym ciągiem.

Jeśli chcesz skomentować wiele wierszy, zrób to zgodnie z wytycznymi PEP 8 :

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

Wynik:

I am a string
clearly I am also a string

Korzystanie z PyCharm IDE.

Możesz commenti uncommentwiersze kodu za pomocą Ctrl + /. Ctrl + / komentarze lub odkomentuje bieżącą linię lub kilka wybranych linii z komentarzami jednowierszowymi ({# in Django templates, or # in Python scripts). Pressing Ctrl+Shift+/dla wybranego bloku kodu źródłowego w szablonie Django otacza ten blok {% comment %} and {% endcomment %}znacznikami.

---

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

print("Loop ended.")

Wybierz wszystkie linie, a następnie naciśnij Ctrl + /

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

# print("Loop ended.")

Komentarz wielowierszowy w rzeczywistości nie istnieje w Pythonie. Poniższy przykład składa się z nieprzypisanego ciągu, który jest sprawdzany przez Python pod kątem błędów składniowych.

Kilka edytorów tekstu, takich jak Notepad ++ , udostępnia skróty do komentowania napisanego fragmentu kodu lub słów.

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

Ponadto Ctrl+ Kjest skrótem w Notepad ++ do blokowania komentarzy. Dodaje #przed każdą linię pod zaznaczeniem. Ctrl+ Shift+ Koznacza blokowanie komentarzy.

Wśród innych odpowiedzi uważam, że najprostszym sposobem jest użycie funkcji komentowania IDE, które korzystają z obsługi komentarzy Pythona #.

Używam Anaconda Spyder i ma:

• Ctrl+ 1- Komentarz / brak komentarza
• Ctrl+ 4- Skomentuj blok kodu
• Ctrl+ 5- Odkomentuj blok kodu

Skomentuje / odkomentuje pojedynczy / wieloliniowy kod / -y kodu #.

Uważam to za najłatwiejsze.

Na przykład komentarz blokowy:

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

Wybierz linie, które chcesz skomentować, a następnie użyj Ctrl+, ?aby skomentować lub odkomentować kod Pythona w edytorze Sublime Text .

W przypadku pojedynczej linii możesz użyć Shift+ #.