Úvod do komentářů v Pythonu
Je nezbytné pochopit průběh programování, co je kódování a na co. Obecně k tomu programátor používá komentáře, aby ukázal, k čemu je ten kus kódu, jaká metoda se používá pro kódování / logiku za ním. Tyto komentáře neovlivní kód, ale poskytnou rozvržení toho, co se děje. Psaní komentářů v kódu pomáhá vylepšovat kód, protože při optimalizaci programátor kontroluje, co je třeba vylepšit, a pokud komentáře ukazují použitou metodu, bude snadné program optimalizovat. Komentáře v Pythonu také dají ostatním vývojářům vědět a pochopit program. Doporučuje se použít dostatečný počet komentářů, aby kód nebyl při zpětném pohledu matoucí.
Typy syntaxe v Pythonu
V Pythonu jsou pro komentáře použity dva typy syntaxí:
#: Is used to comment on one line.
Triple quotes (“): To comment more than one line.
Ve všech programovacích jazycích byla definována určitá syntaxe pro identifikaci toho, co je co. Program je definován řadou syntaxí, např. Pro uzavření řádku vc používáme středník ';', Pro definování začátku třídy nebo smyčky používáme dvojtečku ':'. Jak je vidět, máme jinou syntaxi, která je součástí kódu a ovlivňuje jej. Měla by existovat nějaká syntaxe, která by mohla říci, že je třeba opustit komentovanou část a přejít k dalšímu kroku, protože komentáře s výstupem nemají nic společného. Je tedy opravdu nutné rozlišit komentáře od skutečného kódu, aby se nemělo zaměňovat se skutečným programem.
Vytváření komentářů v Pythonu
Programátor musí do svého programu přidat komentář, aby byl srozumitelnější. Kam teď přidávat komentáře? Je to volba jednotlivce, ale zde jsou některá běžná místa, kde přidávání komentářů činí program čitelnějším.
- Zahájení programu
- Při definování parametrů
- Definování třídy
- Definování metod
- Logika pro metody / funkce
- Popis O postupu
- Křížová kontrola výstupu kusu kódu
Následující body byly vysvětleny níže:
1. Zahájení programu
Zde programátor definuje, co je problémové prohlášení a jaká je potřeba programu.
2. Při definování parametrů
Zde může programátor přidat komentáře ke každému parametru, co znamená, jak pomůže v programu.
3. Definování třídy
Program může obsahovat null / jednu nebo více tříd, takže je nezbytné definovat účel třídy na začátku komentářů. Někdy se doporučuje přidat komentáře mezi třídu, aby se definovala úloha každého řádku ve třídě.
4. Definování metod
Metody jsou funkce, které vytvářejí vztahy mezi parametry a logikou pro manipulaci s nimi. Doporučuje se definovat úlohu metody v komentářích.
5. Logika pro metody / funkce
Obecně může být k metodě připojena řada logik, popis komentářů každé logiky může pomoci pochopit existující logiku a v případě potřeby může být upraven podle požadavku.
6. Popis postupu
Pro každý program programátor postupuje krok za krokem a definování kroků postupu / architektura kódu v komentářích by mohlo pomoci zlepšit jeho čitelnost.
7. Křížová kontrola výstupu kusu kódu
V řadě případů by musel programátor provést změny ve stávajícím programu. Pokud má program řadu logik a musí zkontrolovat, zda všechny fungují dobře, či nikoli, měl by mít referenční výstup / očekávaný výstup. Komentování výstupů této logiky hned po logice by mohlo ušetřit spoustu času.
Příklady komentářů v Pythonu
Příklady jsou uvedeny níže:
Komentáře nemají žádný vliv na výstup toho, co tak někdy, ale dělají program čitelnější. Zde je několik příkladů komentářů v pythonu.
1. Komentování jednoho řádku najednou: Zde provádíme operace sčítání dvou proměnných.
# 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
Výstup: 22
2. Komentování více řádků najednou: Někdy je nutné poskytnout popis nějaké logiky, pro kterou je třeba komentovat více řádků najednou. Komentovat jeden řádek, znovu a znovu, může být únavná práce, proto k tomu používáme trojité uvozovky.
"""
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)
Výstup: 22
3. Komentování jednoho řádku i více řádků najednou: Ve většině případů programátor používá oba typy komentářů, aby byl program lépe čitelný.
"""
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
Výstup: 22
Zde jsme viděli několik případů komentářů, které se používají v programu. V případě strojového učení existují různé typy modelů, které se používají k predikci výstupu. Je třeba modelovat parametry, hyperparametry a procedury použité v algoritmu. Komentování různých přístupů k modelu s různými parametry může ušetřit opakovatelnost a může ušetřit čas.
Závěr - komentáře v Pythonu
Komentáře v programu jsou velmi užitečné pro jejich porozumění. V Pythonu máme v zásadě dva typy komentářů, které buď komentují jeden řádek syntaxí (#), nebo více řádků, které používáme trojité uvozovky (“). Komentáře zde nejsou, aby ovlivnily kód, ale pouze přidaly popis toho, co je tam kódováno, a Komentáře by nebyly součástí výstupu.
Doporučené články
Toto je průvodce poznámkami v Pythonu. Zde diskutujeme o úvodu, vytváření poznámek v Pythonu, o příkladech a syntaxi atd. Další informace naleznete také v našich dalších navrhovaných článcích -
- Výměna v Pythonu
- Příkazy Python
- Reverzní inženýrství s Pythonem
- Výměna v C
- Proměnné v JavaScriptu
- Reverzní inženýrství Použití | Etické problémy
- Jak fungují komentáře v PHP? | Příklady