Komentarze Pythona
- 5000
- 1387
- Klaudia Woś
Wstęp
Ten przewodnik nie chodzi o programowanie. W rzeczywistości nie ma żadnego nowego kodu. Ma to jednak wszystko wspólnego z upewnieniem się, że kod, który piszesz, jest zrozumiały zarówno dla siebie, jak i każdego innego, kto mógłby na to spojrzeć na linię.
Jeśli spojrzałeś na jakiekolwiek projekty open source, prawdopodobnie zauważyłeś notatki umieszczone przez programistów. Te notatki to zwykły tekst. Język programowania nie kompiluje ich ani nie interpretuje w żaden sposób. Po prostu je ignoruje. Wie, że te komentarze są dla ludzi, a nie komputerów.
Komentarze są bardzo ważne. Nawet jeśli nie udostępniasz kodu nikomu innym, wpadniesz w instancję, w której spojrzysz na coś, co napisałeś dawno temu i zastanawiasz się: „Co tu zrobiłem?„Jeśli jesteś zainteresowany pracą nad projektem open source, którym są szanse, ponieważ czytasz to na stronie internetowej Linux, komentowanie jest jeszcze ważniejsze. Ostatnią rzeczą, jakiej chcesz, jest odrzucenie zobowiązania, ponieważ nie zostało skomentowane, a opiekun nie chce marnować czasu na ustalenie, co robi. Komentarze są również ważne w skryptach systemowych. Jest tam bardzo mało jednoosobowych działów IT, a twoi współpracownicy nie będą szczęśliwi, jeśli nie wiedzą, co się dzieje w twoich skryptach.
Komentowanie w Pythonie
Podobnie jak wiele innych języków, Python ma dwa różne rodzaje komentarzy, jednoosobowy. Komentarze z pojedynczym wierszem są doskonałe do dodawania szybkiego komentarza przed blokiem kodu lub zaraz po wierszu kodu wyjaśniającego, co robi. Komentarze wieloletnie są przydatne do dodania nagłówka lub bardziej szczegółowego opisu do kawałka kodu. Są również świetne do komentowania bloku kodu, aby nie działał, co jest świetne do debugowania.
Komentarze z pojedynczym wierszem
W Pythonie jeden z linii zaczyna się od #. Jest to dość powszechny symbol do użycia w językach scenariuszy. Oto przykład tego, jak użyłbyś komentarza jednego wiersza jako opis.
a = 10 b = 15 a = b # Ustaw równe drukuj b (a + b)
Kod będzie działał dokładnie tak, jakby był to, gdyby komentarz nie było. Komentarz jest tylko dla Ciebie.
Możesz także użyć komentarza z jednym wierszem, aby powiedzieć, co zrobi kilka następnych wierszy kodu.
# Importuj bibliotekę matematyczną Importuj matematykę # Uruchom Twierdzenie Pitagorejskie A = 3 B = 4 C = matematyka.sqrt (a ** 2 + b ** 2)
Mimo że jest to prosty przykład, który prawdopodobnie można by wymyślić Jut, patrząc na to, komentarze sprawiają, że patrzenie na to znacznie szybciej. Wyobraź sobie czas, który zostałby zapisany na bardziej złożonym projekcie.
Teraz spójrz na to, jak użyć komentarza jednego wiersza, aby powstrzymać linię kodu przed uruchomieniem.
A = 10 B = 15 # A = B Co się stanie, jeśli A nie jest ustawione równe Drukuj B (A + B)
Linia tego zestawu A równy B nie działał, dając inny wynik niż poprzedni przykład
Komentarze wieloletnie
W Python możesz oznaczyć komentarz wieloletniego, używając „” ” przed i po kodzie, który chcesz skomentować. Oczywiście możesz również użyć tego do dłuższych komentarzy tekstowych, takich jak informacje nagłówka.
„” „Python Test Autor = Twoje imię i nazwisko ostatnio aktualizowane = 1 listopada 2016 r. Wersja Python - 3.4.3 Numer wersji = 1.0.0 "" "
Nic z tego nie znaczy dla komputera, ale doskonale nadaje się do dokumentowania postępów projektu. Utrzymywanie takich informacji w plikach projektu nie wpływa na faktyczny program, ale pozwala Tobie i każdemu innym pracowi nad projektem szybki i łatwy dostęp do ważnych informacji. Jest to świetne do dokumentowania projektów współpracy z wieloma plikami i wieloma autorów. Pamiętaj, że większość projektów rzeczywistych będzie złożona, więc dokumentowanie kodu w ten sposób jest dobrym nawykiem do dostania się.
Komentarze wieloletnie są również niezbędne do debugowania. Powiedzmy, że właśnie zaimplementowałeś nową funkcję swojego projektu, ale ten nowy kod powoduje błąd. Możesz komentować całe jego sekcje, aby przetestować funkcjonalność nowej funkcji po kawałku, aż w końcu dowiesz się, gdzie jest problem. Powiedzmy, że przykład „Pitagorean Twierdzenie” z góry był częścią funkcji, która zawodziła. Możesz zrobić coś takiego jak kod poniżej.
# Zaimportuj bibliotekę matematyczną matematykę „” „Niepowodzenie - Prosimy o debugowanie # Uruchom Twierdzenie Pitagorejskie A = 3 B = 4 C = SQRT (A ** 2 + B ** 2)„ ”„ ”
Możesz także użyć wielu linii, aby zatrzymać stary kawałek kodu podczas wymiany. Po prostu usuwanie kodu nie jest zwykle najlepszą praktyką. W końcu, kiedy go usuniesz, zniknie. Komentowanie tego kodu powstrzymuje go przed uruchomieniem, ale także zachowuje go jako odniesienie lub opadanie na wypadek, gdybyś musiał go ponownie spojrzeć.
Wniosek
Kodowanie kodu jest ważne. To nie można przecenić. Może to wydawać się żmudne i nudne. Nie ma mgły pisania nowej linii zabójcy, która implementuje funkcję, ale na dłuższą metę będziesz szczęśliwy, że te komentarze są tam. Komentarze są również nieocenione narzędzie do debugowania, które może zapewnić solidną procedurę testowania awarii kodu. Ćwicz dalej za pomocą komentarzy i sprawdzania, jak mogą wpływać na przepływ kodu podczas eliminowania linii lub bloków kodu.
Spis treści
- Python Wprowadzenie i instalacja
- Pliki Pythona i tłumacz
- Eksperymentowanie z liczbami i tekstem w Pythonie
- Zmienne Pythona
- Praca ze zmiennymi liczbowymi w Pythonie
- Podstawy strun Python
- Zaawansowane sznurki Pythona
- Komentarze Pythona
- Listy Python
- Metody listy Python
- Listy wielowymiarowe Pythona
- Krotki Pythona
- Operatorzy Python Boolean
- Python Jeśli stwierdzenia
- Python podczas pętli
- Python dla pętli
- Słowniki Pythona
- Python Advanced Dictionaries
- Funkcje Pythona
Powiązane samouczki Linux:
- Wyrażenia regularne Pythona z przykładami
- Zainstaluj Arch Linux na stacji roboczej VMware
- Jak pracować z WooCommerce Rest API z Pythonem
- Jak zbudować aplikację Tkinter za pomocą obiektu zorientowanego na…
- Jak zarządzać repozytoriami GIT z Pythonem
- Samouczek debugowania GDB dla początkujących
- Advanced Bash Regex z przykładami
- Rzeczy do zainstalowania na Ubuntu 20.04
- Pętle bash z przykładami
- Hung Linux System? Jak uciec do wiersza poleceń i…