Komentáře jsou řádky počítačového programu, které pomáhají lépe porozumět funkčnosti systému. V jakémkoli programovacím jazyce jsou komentáře psány přirozeným jazykem a srozumitelným způsobem. Nejsou prováděny, spíše jsou ignorovány kompilátorem nebo tlumočníkem. Komentáře v Pythonu se používají k různým účelům. V tomto článku vám vysvětlíme, jak můžete přidávat komentáře v pythonu.
Výhody používání komentářů v Pythonu
Výhody používání komentářů v Pythonu jsou následující:
Díky komentářům je kód čitelnější: Při vývoji počítačového programu programátor píše více tříd a tisíce řádků kódu. Někdy programátor zapomene, proč je napsána určitá část kódu. Komentáře zajišťují lepší čitelnost kódu a pomáhají nám pamatovat si, proč je kus kódu přidán a jaký je jeho zamýšlený účel.
Komentáře zvyšují srozumitelnost kódu: Komentáře nám pomáhají pochopit, proč je do programu přidán určitý blok kódu a jaký je jeho účel. Pokud programátor napíše blok kódu, nemusí přidat komentáře, protože chápe účel psaní konkrétního bloku kódu. Pokud však chce programátor aktualizovat kód, není pro něj tak snadné pochopit kód během několika minut. Když tedy přidáme komentáře, pomůže to ostatním programátorům porozumět kódu. Předpokládejme, že pracujete na projektu Python. Původně to byl středně velký projekt. Ale teď vaše společnost vylepšit tento projekt a přivést více vývojářů a programátorů k napsání kódu. Pokud ve svém programu nemáte napsané komentáře, uvidíte, že bude pro ně velmi těžké pochopit kód a bude to trvat déle. Ale pokud jste správně napsali komentáře s každým blokem kódu, pak nově najatí vývojáři snadno pochopí stávající kód. Zpočátku psaní a údržba komentářů nějakou dobu trvá, ale v budoucnu vám to ušetří spoustu času.
Komentáře podporují opětovné použití kódu: Když vyvíjíme podobné softwarové systémy, je nejlepším postupem opětovné použití existujícího. Šetří to spoustu našeho úsilí a času. Při opětovném použití kódu nejprve zkontrolujeme, jaké komponenty musíme znovu použít. Musíme pochopit funkčnost konkrétní komponenty. Komentáře nám pomáhají porozumět funkčnosti komponenty a podporují opětovné použití kódu.
Psaní komentářů v Pythonu
Psaní komentářů v Pythonu je velmi snadné. Komentáře v Pythonu začínají značkou #. V pythonu používáme tři typy komentářů:
- Jednořádkové komentáře
- Vložené komentáře
- Víceřádkové komentáře
Jednořádkové komentáře
Jednořádkové komentáře jsou psány krátce v jednom řádku. Jednořádkové komentáře vyjadřují účel psaní konkrétní funkce nebo řádku kódu. V jednoduchém programu je komentář takový:
Výstup
Výstup je vytištěn na konzole Pythonu. Na výstupu se vytiskne pouze „Hello World“. Komentář je kompilátorem ignorován.
Ve smyčce for jsou komentáře podobné tomuto
Vložené komentáře
Vložené komentáře jsou psány na konec řádku kódu. V jednoduchém programu „Hello World“ je vložený komentář takový
Vložený komentář ve smyčce for je takový:
Víceřádkové komentáře
Python neposkytuje odlišný způsob psaní víceřádkových komentářů. Můžeme psát víceřádkové komentáře v Javě, C, C ++ a C #, ale v Pythonu neexistuje žádný samostatný způsob psaní víceřádkových komentářů. Víceřádkové komentáře se obvykle používají k vysvětlení složitého bloku kódu. Ve víceřádkových komentářích každý řádek začíná značkou #. Pokud chceme napsat více řádků komentářů, pak každý řádek bude začínat značkou # takto:
Závěr
Komentáře jsou v programu Python velmi užitečné. Pomáhá nám to porozumět programu. Díky tomu jsou programy Pythonu čitelnější pro lidi. Komentáře podporují opětovnou použitelnost stávajících programů. V tomto článku jsme viděli tři způsoby přidávání komentářů v Pythonu. Pomocí těchto tří způsobů můžete zajistit, aby byly vaše pythonovské programy čitelnější, srozumitelnější a znovu použitelné.