Wprowadzenie do komentarzy w Pythonie
Konieczne jest zrozumienie przebiegu programowania, tego, do czego się programuje i do czego. Zasadniczo, aby to zrobić, programista używa komentarzy, aby pokazać, po co jest ten fragment kodu, jaka metoda jest używana do kodowania / logiki za tym. Te komentarze nie będą miały wpływu na kod, ale zapewnią układ tego, co jest robione. Pisanie komentarzy w kodzie pomaga ulepszyć kod, ponieważ podczas optymalizacji programista sprawdza, co należy poprawić, a jeśli komentarze pokazują zastosowaną metodę, łatwo będzie zoptymalizować program. Komentarze w Pythonie również informują innych programistów o tym, że znają i rozumieją program. Zaleca się stosowanie wystarczającej liczby komentarzy, aby kod nie był mylący, gdy oglądał się za siebie.
Rodzaje składni w Pythonie
W Pythonie istnieją dwa typy składni używanych do komentarzy:
#: Is used to comment on one line.
Triple quotes (“): To comment more than one line.
We wszystkich językach programowania zdefiniowano pewną składnię, aby określić, co jest co. Program jest zdefiniowany za pomocą szeregu składni, np. Do zamykania wiersza wc używamy średnika „;”, Aby zdefiniować początek klasy lub pętli, używamy dwukropka „:”. Jak widać, mamy inną składnię, która jest częścią kodu i wpływa na to. Powinna istnieć pewna składnia, która mogłaby powiedzieć komplement, aby zostawić komentarz i przejść do następnego kroku, ponieważ komentarze nie mają nic wspólnego z wynikiem. Tak więc naprawdę bardzo konieczne jest odróżnienie komentarzy od rzeczywistego kodu, aby nie mylić go z rzeczywistym programem.
Tworzenie komentarzy w Pythonie
Programista musi dodać komentarz do swojego programu, aby był on bardziej zrozumiały. Teraz gdzie dodać komentarze? Jest to wybór indywidualny, ale oto kilka typowych miejsc, w których dodawanie komentarzy sprawia, że program jest bardziej czytelny.
- Rozpoczęcie programu
- Podczas definiowania parametrów
- Definiowanie klasy
- Definiowanie metod
- Logika metod / funkcji
- Opis Informacje o procedurze
- Aby sprawdzić dane wyjściowe fragmentu kodu
Poniżej wyjaśniono następujące punkty:
1. Rozpoczęcie programu
Tutaj programista określa, jakie jest określenie problemu i jaka jest potrzeba programu.
2. Podczas definiowania parametrów
Tutaj programista może dodawać komentarze do każdego parametru, co oznacza, w jaki sposób pomoże w programie.
3. Definiowanie klasy
Program może zawierać wartość null / jedną lub więcej klas, dlatego konieczne jest zdefiniowanie celu klasy na początku komentarzy. Czasami zaleca się dodawanie komentarzy między klasami w celu zdefiniowania zadania każdej linii w klasie.
4. Definiowanie metod
Metody to funkcje, które tworzą relacje między parametrami i logikę do manipulowania nimi. Zaleca się zdefiniowanie zadania metody w komentarzach.
5. Logika metod / funkcji
Ogólnie rzecz biorąc, do metody może być dołączona pewna liczba logik, komentowanie opisu każdej logiki może pomóc w zrozumieniu istniejącej logiki, aw razie potrzeby można ją zmodyfikować zgodnie z wymaganiami.
6. Opis procedury
Dla każdego programu programista postępuje zgodnie z procedurą krok po kroku, a zdefiniowanie etapów procedury / architektury kodu w komentarzach może pomóc poprawić jego czytelność.
7. Aby sprawdzić krzyżowo kod wyjściowy
W wielu przypadkach programista musiałby wprowadzić zmiany w istniejącym programie. Jeśli program ma pewną liczbę logiki i aby sprawdzić, czy wszystkie działają dobrze, czy nie, powinien mieć wyjście referencyjne / wyjście oczekiwane. Komentowanie wyników tej logiki zaraz po logice może zaoszczędzić dużo czasu.
Przykłady komentarzy w Pythonie
Przykłady podano poniżej:
Komentarze nie mają żadnego wpływu na wynik, ale sprawiają, że program jest bardziej czytelny. Oto kilka przykładów komentarzy w pythonie.
1. Komentowanie jednej linii na raz: tutaj wykonujemy operację dodawania dwóch zmiennych.
# Performing addition of two variables
a = 12 # defining variable a and its value
b = 10 # defining variable b and its value
addition = a + b # Addition logic definition
print(addition) # getting output
Wyjście: 22
2. Komentowanie wielu wierszy naraz: Czasami wymagane jest podanie opisu logiki, w przypadku którego istnieje potrzeba komentowania wielu wierszy naraz. Ciągłe komentowanie jednego wiersza może być męczącym zadaniem, dlatego używamy do tego potrójnych cytatów.
"""
These lines are commented to perform addition task
We will define two variables
we will apply addition logic
we will print the output
"""
a = 12
b = 10
addition = a + b
print(addition)
Wyjście: 22
3. Komentowanie jednego wiersza, a także wielu wierszy jednocześnie: W większości przypadków programista używa obu rodzajów komentarzy, aby program był bardziej czytelny.
"""
These lines are commented to perform addition task
We will define two variables
we will apply addition logic
we will print the output
“””
a = 12 # defining variable a and its value
b = 10 # defining variable b and its value
addition = a + b # Addition logic definition
print(addition) # getting output
Wyjście: 22
Tutaj widzieliśmy kilka przypadków komentarzy, które są używane w programie. W przypadku uczenia maszynowego istnieją różne typy modeli, które służą do przewidywania wyników. Trzeba modelować parametry, hiperparametry i procedurę stosowaną w algorytmie. Komentowanie różnych podejść do modelu z różnymi parametrami może zaoszczędzić powtarzalność i czas.
Wniosek - komentarze w Pythonie
Komentarze w programie są bardzo przydatne w ich zrozumieniu. W Pythonie mamy zasadniczo dwa typy komentarzy, aby albo skomentować jedną linię ze składnią (#) lub aby skomentować wiele linii, używamy potrójnych cudzysłowów („). Komentarze nie mają na celu wpłynięcia na kod, ale jedynie dodanie opisu tego, co jest tam kodowane, a Komentarze nie będą częścią wyniku.
Polecane artykuły
To jest przewodnik po komentarzach w Pythonie. Tutaj omawiamy Wprowadzenie, Uwzględnianie tworzenia komentarzy w Pythonie, Przykłady i Składnię itp. Możesz również przejrzeć nasze inne sugerowane artykuły, aby dowiedzieć się więcej -
- Zamiana w Pythonie
- Polecenia w języku Python
- Inżynieria odwrotna z Pythonem
- Zamiana w C
- Zmienne w JavaScript
- Inżynieria odwrotna | Wykorzystuje | Zagadnienia etyczne
- Jak działają komentarze w PHP? | Przykłady