W tym artykule zagłębimy się w koncepcję komentarzy wielowierszowych w Pythonie, podając obszerną definicję wraz z ilustrującymi przykładami w języku programowania Python na temat Jak komentować wiele linii w Pyton .

Co to jest komentarz wielowierszowy w Pythonie?

Komentarze wielowierszowe w Pythonie odnoszą się do bloku tekstu lub instrukcji używanych w kodzie w celach objaśniających lub dokumentacyjnych. W odróżnieniu od komentarzy jednowierszowych oznaczonych symbolem krzyżyka (#), komentarze wielowierszowe są ujęte w potrójne cudzysłowy (``) lub potrójne cudzysłowy pojedyncze (``). Komentarze te są często wykorzystywane do dostarczania szczegółowych wyjaśnień, dokumentacji lub notatek na temat kodu i mogą obejmować wiele wierszy. Chociaż w Pythonie nie ma specyficznej składni dla komentarzy wielowierszowych, podobny efekt można osiągnąć stosując potrójne cudzysłowy, ponieważ interpreter ignoruje załączony tekst.

Rodzaje komentarzy wielowierszowych w Pythonie

Istnieją dwa sposoby dodawania komentarzy wielowierszowych w języku Python do naszego kodu. Są one następujące:

• Kolejny komentarz jednowierszowy
• Używanie ciągu wielowierszowego jako komentarza
• Korzystanie z metody ukośnika odwrotnego

Skomentuj wiele linii w Pythonie, używając kolejnego komentarza jednowierszowego

W Pyton , znak skrótu (#) jest używany do komentowania linii. Pojedyncza linia komentarze w Pythonie nie muszą być samym tekstem wyjaśniającym kod, można ich również użyć, aby uniemożliwić Pythonowi wykonanie kodu. Znak skrótu powinien być umieszczony przed każdą linią, aby był traktowany jako komentarz wielowierszowy w Pythonie.

Przykład: kolejny komentarz jednowierszowy

Tutaj pierwsze dwie linie zawierają znak skrótu (#), a interpreter uniemożliwia wykonanie tych dwóch linii. Następnie wypisuje komentarze Pythona i na koniec uniemożliwia wykonanie ostatniej linii.

# Write Python3 code here # Single line comment used print('Python Comments') # print('Mathematics')>

Wyjście:

Python Comments>

Skomentuj wiele linii w Pythonie, używając ciągu wielowierszowego jako komentarza

Komentarze wielowierszowe w języku Python można również ująć w ogranicznik (). Ponownie nie powinno być białych znaków pomiędzy ogranicznikami (). Są przydatne, gdy tekst komentarza nie mieści się w jednej linii i dlatego musi rozciągać się między liniami. Ten typ literału łańcuchowego jest ignorowany, ponieważ nie jest przypisany do żadnej zmiennej. Dostęp do tych ciągów możemy uzyskać za pomocą __doc__.

Przykład: użycie ciągu wielowierszowego jako komentarza

Komentarze wieloliniowe służą do komentowania więcej niż jednej linii. Pierwsza linia to komentarz jednowierszowy. Drugi i trzeci wiersz można skomentować, używając potrójnych cudzysłowów ( ). Uniemożliwia to wykonanie powyższego kodu. Na koniec wypisuje na wyjściu matematykę. Jeśli jednak te wielowierszowe komentarze Pythona zostaną umieszczone bezpośrednio po podpisie funkcji lub klasy, wówczas zmienią się one w dokumenty .

# Write Python code here ''' Multi-line comment used print('Python Comments') ''' print('Mathematics')>

Wyjście:

Mathematics>

Skomentuj wiele linii w Pythonie, używając metody ukośnika odwrotnego

Metoda tworzenia komentarzy wielowierszowych w Pythonie polega na użyciu ukośnika odwrotnego (``) na końcu każdej linii w celu wykorzystania funkcji kontynuacji linii, umożliwiając w ten sposób rozszerzenie komentarza do następnej linii. Ta metoda kontynuacji wiersza jest mniej powszechna niż inne podejścia, takie jak kolejne jednowierszowe komentarze lub ciągi wielowierszowe i jest stosowana głównie ze względu na czytelność kodu, gdy konieczne jest podzielenie komentarza na wiele wierszy.

Przykład : W tym przykładzie komentarze zaczynające się od#>są rozszerzane do wielu linii za pomocą ukośnika odwrotnego (>) na końcu każdej linii. Ukośnik odwrotny oznacza, że ​​komentarz będzie kontynuowany w następnym wierszu. Ta metoda może być pomocna w poprawianiu czytelności kodu w przypadku długich komentarzy.

# Using backslash for multiline comments # This is a long comment  # that spans multiple lines  # using the backslash continuation method. # Code continues below print('Hello, World!')>

Wyjście :

Hello, World!>

Dokumenty w Pythonie

The dokumentacja to wbudowana funkcja języka Python, która służy do łączenia dokumentacji napisanej z modułami, funkcjami, klasami i metodami języka Python. Jest dodawany tuż pod funkcjami, modułami lub klasami, aby opisać, co robią. W Pythonie dokumentacja jest następnie udostępniana poprzez Python __doc__ atrybut.

Przykład: Dokumenty w Pythonie

W tym przykładzie po zdefiniowaniu funkcji multiply() zadeklarowaliśmy komentarz w dokumencie, używając potrójnych cudzysłowów. Następnie drukujemy dokument za pomocą atrybutu __doc__.

def multiply(a, b):  '''Multiplies the value of a and b''' return a*b # Print the docstring of multiply function print(multiply.__doc__)>

Wyjście:

Multiplies the value of a and b>

Różnica między komentarzami a dokumentacją w Pythonie

Zobaczmy różnicę między komentarzami w Pythonie a Docstringiem: