Sissejuhatus Pythoni kommentaaridesse
Oluline on mõista programmeerimise voogu, seda, mida kodeeritakse ja milleks. Üldiselt kasutab programmeerija selleks kommentaare, et näidata, milleks see kooditükk on, millist meetodit kasutatakse kodeerimiseks / selle taga olevat loogikat. Need kommentaarid ei mõjuta koodi, kuid see annab tehtud töö paigutuse. Kommentaaride kirjutamine koodis aitab koodi paremaks muuta, kuna optimeerimisel kontrollib programmeerija seda, mida on vaja parandada, ja kui kommentaarid näitavad kasutatud meetodit, on programmi optimeerimine lihtne. Pythoni kommentaarid annavad teistele arendajatele ka programmi tundma ja mõista. Soovitatav on kasutada piisavat arvu kommentaare, nii et kood ei oleks tagasi vaadates segane.
Süntaksi tüübid Pythonis
Pythonis on kommentaaride jaoks kasutatud kahte tüüpi süntaksit:
#: Is used to comment on one line.
Triple quotes (“): To comment more than one line.
Kõigis programmeerimiskeeltes on määratletud süntaks, mis võimaldab kindlaks teha, mis on mis. Programm on defineeritud paljude süntaksidega, näiteks rea sulgemiseks c-s kasutatakse semikoolonit ';', Klassi või silmuse alguse määratlemiseks kasutatakse koolonit ':'. Nagu näha, on meil erinev süntaks, mis on osa koodist ja mõjutab seda. Peaks olema mingi süntaks, mis võiks öelda, et kommenteerija jätaks kommentaaritud osa ja jätkaks järgmise sammuga, kuna kommentaaridel pole väljundiga mingit pistmist. Seega on tõesti väga vaja eristada kommentaare tegelikust koodist, nii et neid ei tohiks segi ajada tegeliku programmiga.
Kommentaaride loomine Pythonis
Programmeerija peab oma programmi lisama kommentaari, et see oleks arusaadavam. Kuhu nüüd kommentaare lisada? See on inimese enda valitud, kuid siin on mõned tavalised kohad, kus kommentaaride lisamine muudab programmi loetavamaks.
- Programmi algus
- Parameetrite määratlemisel
- Klassi määratlemine
- Meetodite määratlemine
- Meetodite / funktsioonide loogika
- Kirjeldus Menetluse kohta
- Kooditüki väljundi ristkontrollimiseks
Allpool on selgitatud järgmisi punkte:
1. Programmi algus
Programmeerija määratleb siin, mis on probleemilause ja mis on programmi vajadus.
2. Parameetrite määratlemisel
Siin saab programmeerija lisada iga parameetri kohta märkusi, mille jaoks see tähistab, kuidas see programmis abistab.
3. Klassi määratlemine
Programm võib sisaldada null / ühte või mitut klassi, seetõttu on oluline kommentaari alguses määratleda klassi eesmärk. Mõnikord soovitatakse klassis iga rea töö määratlemiseks lisada klasside vahele märkusi.
4. Meetodite määratlemine
Meetodid on funktsioonid, mis loovad seoseid parameetrite ja sellega manipuleerimise loogika vahel. Meetodi töö on soovitatav määratleda kommentaarides.
5. Meetodite / funktsioonide loogika
Üldiselt võib meetodile lisada mitu loogikat, iga loogika kommenteeriv kirjeldus aitab olemasolevat loogikat mõista ja vajadusel saab seda vastavalt nõudele muuta.
6. Protseduuri kirjeldus
Iga programmi puhul järgib programmeerija samm-sammult protseduuri ja protseduuri etappide määratlemine / koodi arhitektuur kommentaarides võib aidata selle loetavust parandada.
7. Kooditüki väljundi ristkontrollimiseks
Mitmel juhul peaks programmeerija tegema olemasolevas programmis muudatusi. Kui programmil on palju loogikaid ja selleks, et kontrollida, kas kõik töötab hästi, peaks tal olema võrdlusväljund / eeldatav väljund. Selle loogika väljundite kommenteerimine vahetult pärast loogikat võiks palju aega kokku hoida.
Kommentaaride näited Pythonis
Näited on toodud allpool:
Kommentaarid ei avalda väljundile mingit mõju, aga nii muudavad need programmi loetavamaks. Siin on mõned näited pütoni kommentaaridest.
1. Ühe rea kommenteerimine korraga: siin teostame kahe muutuja liitmisoperatsiooni.
# 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äljund: 22
2. Mitme rea korraga kommenteerimine: Mõnikord tuleb esitada mõne loogika kirjeldus, mille jaoks on vaja kommenteerida mitut rida korraga. Ühe rea uuesti ja uuesti kommenteerimine võib olla väsitav töö, seetõttu kasutame selle jaoks kolmekordset jutumärki.
"""
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äljund: 22
3. Kommenteerimine ühe ja mitme reaga korraga: enamasti kasutab programmeerija mõlemat tüüpi kommentaare, et muuta programm loetavamaks.
"""
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äljund: 22
Siin nägime mõnda juhtumit kommentaaride kohta, mida programmis kasutatakse. Masinõppe puhul on erinevat tüüpi mudeleid, mida kasutatakse väljundi ennustamiseks. Algoritmis kasutatavad parameetrid, hüperparameetrid ja protseduurid tuleb modelleerida. Erinevate parameetritega mudeli erinevate lähenemisviiside kommenteerimine võib päästa korratavuse ja aja kokkuhoiu.
Järeldus - märkused Pythonis
Programmi kommentaarid on nende mõistmiseks väga kasulikud. Pythonis on meil põhimõtteliselt kahte tüüpi kommentaare, kas ühe rea kommenteerimiseks (#) süntaksiga või mitme rea kommenteerimiseks kasutame kolmekordset jutumärki (“). Kommentaarid ei ole koodi mõjutamiseks, vaid lihtsalt kirjelduse lisamiseks sinna, mida seal kodeeritakse. Kommentaarid ei oleks osa väljundist.
Soovitatavad artiklid
See on juhend Kommentaarid Pythonis. Siin käsitleme sissejuhatust, Pythonis kommentaaride loomist on arvesse võetud, näiteid ja süntaksi jne. Lisateabe saamiseks võite minna ka meie teistest soovitatud artiklitest -
- Vahetus Pythonis
- Pythoni käsud
- Pöördtehnika Pythoniga
- C-s vahetamine
- Muutujad JavaScriptis
- Pöördtehnika | Kasutab | Eetilised probleemid
- Kuidas kommentaarid toimivad PHP-s? | Näited