›_ ebskola.lv
← 2.3 2.5 →

2.4 Koda stils un komentāri

Stundas uzdevums: Lietot profesionālus koda rakstīšanas standartus, sastādīt skaidrus komentārus un strukturēt programmu tā, lai tā būtu saprotama gan datoram, gan citiem izstrādātājiem.

2.4.8. Dokumentē kodu un ievero koda noformēšanas vadlīnijas.

70 min darba sadalījums: 1. uzdevums (~20 min) - atjauno teorijas piemēru vai minimālo prototipu; 2. uzdevums (~25 min) - pielieto to galvenajā uzdevumā; 3. uzdevums (~25 min) - pārbaudi rezultātu, izlabo kļūdas un tikai beigās pieraksti vienu secinājumu. Papildus/4. līmeņa uzdevums ir paredzēts tikai tad, ja pamatdarbs ir pabeigts.

Pirms sāc: izmanto iepriekš apgūto un šīs lapas teorijas/koda piemērus. Ja vajadzīga jauna komanda vai rīks, vispirms atrodi tās paraugu teorijas sadaļā.

Teorija: Profesionāla koda kultūra

Programmēšanā koda lasāmība ir tikpat svarīga kā tā funkcionalitāte. Lūk, galvenie standarti:

Praktiskie uzdevumi

1. uzdevums - Iesildies ar gatavu piemēru

Šis ir īss iesildīšanās uzdevums. Nokopē sagatavi, ielīmē to pareizajā koda vietā un palaid. Šeit pietiek droši izmēģināt tēmu 2.4 Koda stils un komentāri; detalizētu izpratni veidosi nākamajos uzdevumos.

Kopējamais piemērs vai sagatave: izmanto šo bloku kā starta punktu, nevis kā gala risinājumu.

"""
Spēles 'Duelis' galvenais aprēķinu modulis.
Autors: Jānis Bērziņš (2026)
"""
  1. Atver darba failu vai rīku. Python fragmentu ievieto main.py failā un palaid no termināļa.
  2. Nokopē visu piemēra bloku no šī uzdevuma un ielīmē to norādītajā vietā.
  3. Palaid kodu tieši tādu, kāds tas ir, un pārliecinies, ka parādās rezultāts, izvade vai vismaz nav kļūdas paziņojuma.
  4. Atrodi vienu drošu vietu, ko drīkst mainīt: tekstu, skaitli, krāsu, mainīgā vērtību vai testa ierakstu.
  5. Maini tikai šo vienu vērtību un palaid kodu vēlreiz.
  6. Salīdzini rezultātu pirms un pēc izmaiņas. Ja parādās kļūda, atcel pēdējo izmaiņu un palaid vēlreiz.
  7. Turpini pie 2. uzdevuma tikai tad, kad šis mazais piemērs darbojas.

2. uzdevums - Ievieto algoritmu projektā

Pievieno šīs stundas paņēmienu kā nelielu, strādājošu projekta daļu.

  1. Izvēlies vienu konkrētu projekta vietu: ievadi, aprēķinu, izvēli, ciklu, datu struktūru, funkciju vai rezultāta izvadi.
  2. Nosauc funkcijas un mainīgos pēc to lomas, piemēram, punkti, gajiens, atbilde, rezultats vai parbauda_ievadi().
  3. Uzraksti funkciju vai koda bloku, kas nolasa sākuma datus, tos apstrādā un atgriež vai izvada rezultātu.
  4. Savieno šo kodu ar jau esošo projekta plūsmu, nevis atstāj to atsevišķā demonstrācijā.
  5. Pievieno vienu īsu komentāru pie sarežģītākās darbības.
  6. Pārbaudi, ka iepriekšējais kods joprojām darbojas pēc jaunā fragmenta pievienošanas.
  7. Salabo pirmo atrasto kļūdu pirms paplašini risinājumu.
  8. Veic Git commit ar īsu ziņu par pievienoto funkcionalitāti.

3. uzdevums - Testē kodu un izdari secinājumu

Pārbaudi, vai algoritms darbojas paredzami vairākās situācijās.

  1. Izveido trīs testa scenārijus: parasta ievade, robežgadījums un kļūdaina vai tukša ievade.
  2. Palaid parasto scenāriju un pārbaudi termināļa izvadi.
  3. Palaid robežgadījumu ar mazāko, lielāko vai tukšāko vērtību, ko šis kods var saņemt.
  4. Palaid kļūdaino scenāriju un pārbaudi, vai programma neavarē.
  5. Izlabo vienu konkrētu problēmu kodā, datos vai ievades pārbaudē.
  6. Pārbaudi labojumu vēlreiz ar visiem trim scenārijiem.
  7. Beigās pieraksti vienu secinājumu: kura koda rinda vai algoritma solis vislabāk palīdzēja saprast tēmu 2.4 Koda stils un komentāri.

Papildu uzdevums - Pievieno mazu funkciju

Ja pamatdarbs ir pabeigts, paplašini projektu ar vienu nelielu programmētu uzlabojumu.

  1. Izvēlies vienu mazu papildinājumu, kas izmanto to pašu šīs stundas paņēmienu.
  2. Pievieno vienu jaunu mainīgo, funkciju, nosacījumu, ciklu, datu elementu vai rezultāta izvadi.
  3. Savieno papildinājumu ar esošo projekta kodu.
  4. Pārbaudi, ka pamatfunkcija un papildinājums darbojas kopā.
  5. Saglabā izmaiņas ar Git commit tikai pēc veiksmīgas pārbaudes.

Biežākās kļūdas (un kā tās labot):

  • Pārāk daudz komentāru: Komentēšana ir laba, taču koda "pārkomentēšana" padara to netīru. Nevajag rakstīt # Izvada rezultātu blakus print(rezultats). Tas jau ir acīmredzami.
  • Nekonsekvents stils: Ja vienu mainīgo nosauksi mans_speks, bet nākamo TavsSpeks, kods izskatīsies neprofesionāli un būs grūtāk atcerēties pareizo sintaksi. Pieturies pie Snake Case.
  • Kļūdaini Docstrings: Vairāku rindu komentāriem jāizmanto tieši trīs pēdiņas (""") gan sākumā, gan beigās.

Mainīgo nosaukumu salīdzinājums

Kritērijs Slikts piemērs Labs piemērs (Snake Case)
Skaidrība s = 100 sakuma_dzivibas = 100
Konsekvence SpeletajaVards speletaja_vards
Jēga d1, d2, d3 speks, aizsardziba, veiksme

Profesionāla koda paraugs

"""
Vienkāršs aprēķinu skripts cīņas mehānikai.
Izmanto PEP 8 standartus un atbilstošus mainīgo nosaukumus.
"""

ienaidnieka_hp = 100
mana_jauda = 25

# Aprēķins, ievērojot PEP 8 atstarpes ap operatoriem
atlikums = ienaidnieka_hp - mana_jauda

print(f"Ienaidniekam palika {atlikums} HP.")
Ienaidniekam palika 75 HP.
⬅ Iepriekšējā stunda Nākamā stunda ➡