Úvod do komentárov v Pythone
Je nevyhnutné pochopiť priebeh programovania, čo kóduje a na čo. Vo všeobecnosti programátor používa na to, aby ukázal, čo je to za kus kódu, za akú metódu sa používa na kódovanie / logiku za ním. Tieto komentáre nebudú mať vplyv na kód, ale poskytnú rozloženie toho, čo sa robí. Písanie poznámok v kóde pomáha vylepšiť kód, pretože pri optimalizácii programátor kontroluje, čo je potrebné vylepšiť, a ak pripomienky ukážu použitú metódu, bude ľahké program optimalizovať. Komentáre v Pythone tiež informujú ostatných vývojárov o programe a porozumeli mu. Odporúča sa použiť dostatočný počet komentárov, aby sa pri spätnom pohľade nezavádzal zmätok.
Typy syntaxe v Pythone
V Pythone sú pre komentáre použité dva typy syntaxí:
#: Is used to comment on one line.
Triple quotes (“): To comment more than one line.
Vo všetkých programovacích jazykoch bola definovaná určitá syntax na identifikáciu toho, čo je čo. Program je definovaný množstvom syntaxí, napr. Pri zatváraní riadku vc používame bodkočiarku ';', Na definovanie začiatku triedy alebo slučky používame dvojbodku ':'. Ako vidno, máme inú syntax, ktorá je súčasťou kódu a ovplyvňuje ho. Mala by existovať nejaká syntax, ktorá by mohla povedať, že je komplikovanejšia, nechať časť s komentármi a prejsť na ďalší krok, pretože komentáre nemajú nič spoločné s výstupom. Je preto skutočne nevyhnutné rozlišovať komentáre od skutočného kódu, aby sa nemalo zamieňať so skutočným programom.
Vytváranie komentárov v Pythone
Programátor musí do svojho programu pridať komentár, aby bol zrozumiteľnejší. Kam teraz pridávať komentáre? Je to voľba jednotlivca, ale tu sú niektoré bežné miesta, kde pridávanie komentárov zvyšuje čitateľnosť programu.
- Začiatok programu
- Pri definovaní parametrov
- Definovanie triedy
- Definovanie metód
- Logika pre metódy / funkcie
- Opis Informácie o postupe
- Na krížovú kontrolu výstupu časti kódu
Nasledujúce body boli vysvetlené nižšie:
1. Začiatok programu
Tu programátor definuje, čo je problémové vyhlásenie a aká je potreba programu.
2. Pri definovaní parametrov
Tu môže programátor pridať komentáre ku každému parametru, čo znamená, ako pomôže v programe.
3. Definovanie triedy
Program môže obsahovať null / jednu alebo viac tried, takže je nevyhnutné definovať účel triedy na začiatku komentárov. Niekedy sa odporúča pridať do triedy poznámky, aby sa definovala úloha každého riadku v triede.
4. Definovanie metód
Metódy sú funkcie, ktoré vytvárajú vzťahy medzi parametrami a logikou pre ich manipuláciu. Odporúča sa definovať úlohu metódy v komentároch.
5. Logika metód / funkcií
Vo všeobecnosti môže mať metóda k nemu pripojenú množstvo logík. Komentár popis každej logiky môže pomôcť pochopiť existujúcu logiku a ak je to potrebné, môže byť upravený podľa požiadavky.
6. Opis postupu
Pre každý program programátor postupuje krok za krokom a definovanie krokov postupu / architektúry kódu v komentároch by mohlo pomôcť zlepšiť jeho čitateľnosť.
7. Krížová kontrola výstupu časti kódu
V mnohých prípadoch by musel programátor vykonať zmeny v existujúcom programe. Ak má program množstvo logík a musí skontrolovať, či všetky fungujú dobre alebo nie, mal by mať referenčný výstup / očakávaný výstup. Komentovanie výstupov tejto logiky hneď po logike by mohlo ušetriť veľa času.
Príklady komentárov v Pythone
Príklady sú uvedené nižšie:
Komentáre nemajú žiadny vplyv na výstup toho, čo vôbec, ale zvyšujú čitateľnosť programu. Tu je niekoľko príkladov poznámok v pythone.
1. Komentovanie jedného riadku súčasne: Tu vykonávame sčítanie dvoch premenný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. Komentovanie viacerých riadkov naraz: Niekedy je potrebné poskytnúť opis nejakej logiky, pre ktorú je potrebné komentovať viac riadkov súčasne. Komentovanie jedného riadku, znova a znova, by mohlo byť únavnou úlohou, preto na tento účel uvádzame trojité úvodzovky.
"""
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. Komentovanie jedného riadku, ako aj viacerých riadkov súčasne: Vo väčšine prípadov programátor používa oba typy komentárov, aby bol program čitateľnejší.
"""
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
Tu sme videli niektoré prípady pripomienok, ktoré sa používajú v programe. V prípade strojového učenia existujú rôzne typy modelov, ktoré sa používajú na predpovedanie výstupu. Je potrebné modelovať parametre, hyperparametre a postupy použité v algoritme. Komentovanie rôznych prístupov k modelu s rôznymi parametrami môže ušetriť opakovateľnosť a môže ušetriť čas.
Záver - Komentáre v Pythone
Komentáre v programe sú veľmi užitočné pri ich porozumení. V Pythone máme v zásade dva typy komentárov, ktoré môžu komentovať jeden riadok syntaxou (#) alebo komentovať viac riadkov, ktoré používame trojité úvodzovky (“). Komentáre nie sú určené na ovplyvnenie kódu, ale iba na doplnenie popisu toho, čo je tam kódované a Komentáre by neboli súčasťou výstupu.
Odporúčané články
Toto je príručka pre komentáre v Pythone. Tu diskutujeme o úvodu, vytvorení komentárov v Pythone, o príkladoch a syntaxi atď. Ďalšie informácie nájdete aj v ďalších navrhovaných článkoch -
- Výmena v Pythone
- Príkazy Python
- Reverzné inžinierstvo s Pythonom
- Výmena v C
- Premenné v JavaScripte
- Reverzné inžinierstvo Použitie Etické problémy
- Ako fungujú komentáre v PHP? | Príklady