Pythonis mitmerealiste kommentaaride tegemine: täielik juhend algajatele ja edasijõudnutele

1. Sissejuhatus

Python on programmeerimiskeel, mida kasutavad nii algajad kui ka edasijõudnud arendajad, ning koodi haldamine on lihtne. Kuid programmi osade ajutiseks keelamiseks või teistele arendajatele selgituste jätmiseks on „kommenteerimine” äärmiselt oluline. Eriti mitmerealine kommenteerimine on hädavajalik tehnika, mis aitab nii silumisel kui ka koodi mõistmisel.

Selles artiklis selgitame erinevaid viise, kuidas Pythonis mitut rida korraga kommenteerida. Tutvustame #-märgi kasutamist, kolmekordsete jutumärkide meetodit ning arenduskeskkondade otseteid, mis võimaldavad tõhusalt kommenteerida. Ka algajad saavad sellest kergesti aru, sest toome välja konkreetsed koodinäited. Võta kindlasti eeskujuks!

2. Pythoni põhimeetodid kommenteerimiseks

Pythonis kommenteerimiseks kasutatakse kõigepealt #-märki. Kui lisad rea algusesse #, siis see rida muudetakse kommentaariks ning seda ei käivitata. See meetod on lihtne ning mugav koodi selgituste lisamiseks või ajutiseks väljalülitamiseks.

2.1 Rea kaupa kommenteerimine

Rea algusesse # kirjutades muudetakse see rida kommentaariks.

# See on üherealine kommentaar
print("Hello, World!")  # Siia saab kirjutada ka rea sees kommentaari

Kommenteerida saab rida-realt, mis tähendab, et kommentaare saab lisada ükskõik kuhu, aidates koodi paremini mõista.

2.2 Mitmerealine kommenteerimine

Kui soovid mitut rida korraga keelata, lisa iga rea algusesse #. Seda kasutatakse näiteks silumisel või kui soovid ajutiselt mitut rida peatada.

# Seda koodi ei käivitata
# See on mitmerealine kommentaar
print("See rida on keelatud")

3. Mitmerealise kommenteerimise meetodid

Lisaks #-märgile on Pythonis veel mitmeid viise, kuidas mitut rida korraga kommenteerida. Efektiivseteks lahendusteks on näiteks otseteed või kolmekordsed jutumärgid.

3.1 Mitmerealine kommenteerimine otseteega

Enamikus arenduskeskkondades saab valida mitu rida ning lisada neile korraga # otsetee abil. Näiteks Visual Studio Code’is saab kasutada Ctrl + /, et kommenteerida korraga mitu rida.

# Näide: vali mitu rida ja kommenteeri
# a = 1
# b = 2
# c = a + b

Nii saad kiiresti lisada kommentaare ilma igale reale eraldi # kirjutamata.

3.2 Kolmekordsete jutumärkide kasutamine

Pythonis saab mitmerealist kommenteerimist teha ka kolmekordsete jutumärkidega, mida muidu kasutatakse dokumendikommentaaride (docstringide) jaoks. Seda saab kasutada alternatiivse meetodina.

'''
See osa on kommenteeritud.
Sobib juhul, kui soovid mitut rida korraga keelata.
'''
print("See rida töötab")

Pane tähele, et kolmekordsed jutumärgid loetakse stringiks, seega kasuta neid õigetes kohtades, et vältida liigset mälukulu.

4. Kolmekordsete jutumärkide näited ja tähelepanekud

Kolmekordseid jutumärke kasutades tuleb olla ettevaatlik. Taande peab olema korrektne, muidu võib tekkida viga.

4.1 Õige näide

Õigeks kasutamiseks peab taane olema ühtlane:

def sample():
    '''
    Seda käsitletakse kommentaarina.
    Taanded on korrektsed.
    '''
    print("See rida käivitatakse")

4.2 Vigane näide

Kui taanded on valed, tekib IndentationError:

def sample():
'''
See kommentaar tekitab vea
Taane ei ole korrektne
'''
    print("Siin tekib viga")

Seega pead kolmekordseid jutumärke kasutades jälgima taanet.

5. Kommenteerimise otseteed arenduskeskkondades

Erinevates arenduskeskkondades on olemas otseteed mitme rea kommenteerimiseks. Vaatame, kuidas seda teha tööriistades nagu PyCharm, Visual Studio Code ja Jupyter Notebook.

5.1 PyCharm

PyCharms saab kommenteerida ridu kiiresti Ctrl + / abil, olgu tegemist üksiku rea või mitmega.

5.2 Visual Studio Code

Visual Studio Code’is saab samuti kasutada Ctrl + /, kuid blokk-kommentaaride puhul saab kasutada Shift + Alt + A.

5.3 Jupyter Notebook

Jupyter Notebookis töötab samuti Ctrl + /, mis on andmeteadlaste ja inseneride jaoks väga kasulik.

6. Parimad praktikad kommenteerimisel

Kommentaarid aitavad koodi mõista ja selgitada kavatsusi, kuid liiga palju kommentaare võib hoopis raskendada lugemist. Vaatame häid ja halbu näiteid.

6.1 Hea kommentaari näide

Kommentaarid peaksid kirjeldama eesmärki, mitte lihtsalt koodi tegevust:

# Võtab argumendid a ja b ning tagastab nende summa
def add(a, b):
    return a + b

6.2 Liigsed kommentaarid

Ülemäärased kommentaarid muudavad koodi raskemini loetavaks. Näiteks:

# omistab 1 muutujale a
a = 1
# omistab 2 muutujale b
b = 2
# liidab a ja b
c = a + b

7. Kokkuvõte

Pythonis saab mitmerealist kommenteerimist teha mitmel viisil: kasutades #, kolmekordseid jutumärke või arenduskeskkondade otseteid. #-märgi meetod on lihtne ja töötab peaaegu alati, kuid ka teised meetodid muudavad töö efektiivsemaks.

Kasuta neid tehnikaid, et oma kood selgemaks ja arendustöö sujuvamaks muuta!