ebSkola

2. tēma / 2.4

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 plāns: Teorija un paraugs (~10 min) · 1. uzdevums (~15 min) - pārsauc mainīgos snake_case · 2. uzdevums (~25 min) - sakārto kodu pēc PEP 8 un uzraksti jēdzīgus komentārus · 3. uzdevums (~20 min) - pārbaudi lasāmību ar klasesbiedru. Papildu uzdevumu sāc tikai tad, ja pārējie trīs ir gatavi.

Pirms sāc: atver savu 2.3 stundas failu matematika.py - šajā stundā to nevis papildināsi, bet sakārtosi.

Teorija: Profesionāla koda kultūra

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

  • Comments (Komentāri) #: Dators tos ignorē, bet tie palīdz cilvēkiem saprast koda nolūku. Raksti par to, kāpēc kods kaut ko dara, nevis apraksti acīmredzamo. 
    # Slikti: Pārvērš ievadi par skaitli un pieskaita 10
rezultats = int(input()) + 10

# Labi: Pievieno bāzes punktu bonusu jaunajam spēlētājam
kopejie_punkti = int(input("Punkti: ")) + 10
  • Snake Case: Python standarts Variables (Mainīgo) nosaukumiem. Visi burti ir mazie, un vārdus atdala ar apakšsvītru (Underscore). 
    speletaja_vards = "Anna" # Pareizi
SpeletajaVards = "Anna" # Nepareizi (Camel Case nav ieteicams Python mainīgajiem)
  • PEP 8: Oficiālā Python stila rokasgrāmata. Viens no galvenajiem noteikumiem: vienmēr lieto atstarpes (Whitespace) ap operatoriem. 
    a = 5 + 2  # PEP 8 standarts
a=5+2      # Kļūdains stils
  • Docstrings (Dokumentācijas virknes) """: Vairāku rindu komentāri faila sākumā vai funkcijās, lai aprakstītu kopējo mērķi un autorību. 
    """
Spēles 'Duelis' galvenais aprēķinu modulis.
Autors: Jānis Bērziņš (2026)
"""

Praktiskie uzdevumi

1. uzdevums -

Pārsauc mainīgos snake_case

Beigās visi tavi mainīgo vārdi izskatīsies tā, kā raksta Python programmētāji.

  1. Izveido jaunu failu stils.py un ieraksti tajā SpeletajaVards = "Anna".
  2. Pievieno HPpunkti = 100 un x = 25.
  3. Pārsauc pirmo mainīgo par speletaja_vards.
  4. Pārsauc otro par hp_punkti.
  5. Pārsauc trešo par tādu vārdu, kas pasaka, kas tas ir, piemēram uzbrukuma_jauda.
  6. Palaid kodu un pārliecinies, ka nekas nav salūzis.

Gatavs, kad: nevienā mainīgā vārdā nav lielo burtu, un no katra vārda var saprast, kas tajā glabājas.

2. uzdevums -

Sakārto kodu pēc PEP 8 un uzraksti jēdzīgus komentārus

Beigās tavs kods būs salasāms arī pēc mēneša.

  1. Pievieno atstarpes ap katru operatoru: atlikums = hp_punkti - uzbrukuma_jauda.
  2. Pievieno tukšu rindu starp mainīgo definēšanu un aprēķiniem.
  3. Uzraksti komentāru, kas paskaidro, kāpēc tiek atņemta jauda, nevis ko atņem.
  4. Izdzēs komentārus, kas tikai atkārto kodu, piemēram # atņem jaudu.
  5. Pievieno faila sākumā trīskāršās pēdiņās īsu aprakstu, ko šī programma dara.
  6. Palaid kodu un pārliecinies, ka tas joprojām strādā.

Gatavs, kad: failā ir apraksts sākumā, tukšas rindas starp daļām un neviens komentārs neatkārto to, ko rinda jau pasaka.

3. uzdevums -

Pārbaudi lasāmību ar klasesbiedru

Beigās tu uzzināsi, vai tavs kods ir saprotams kādam citam, ne tikai tev.

  1. Apmainies ar klasesbiedru: iedod savu stils.py un paņem viņa failu.
  2. Izlasi saņemto kodu un pieraksti, ko tas dara, neprasot autoram.
  3. Atzīmē vienu mainīgo, kura vārds tev nebija skaidrs.
  4. Atdod pierakstu autoram un saņem savu.
  5. Pārsauc savā kodā to mainīgo, kuru klasesbiedrs nesaprata.
  6. Pieraksti vienu secinājumu: kāpēc labs mainīgā vārds ir svarīgāks par komentāru.

Gatavs, kad: klasesbiedrs pareizi pateica, ko tava programma dara, un tu esi izlabojis vismaz vienu neskaidru vārdu.

Papildu uzdevums - Pārbaudi kodu ar rīku

Ja pamatdarbs ir gatavs, ļauj datoram pateikt, kur stils neatbilst standartam.

  1. Atver VS Code Extensions un atrodi paplašinājumu Pylint vai Flake8.
  2. Uzstādi to un atver savu stils.py.
  3. Paskaties uz viļņotajām līnijām zem koda un izlasi vienu brīdinājumu.
  4. Izlabo vienu no norādītajām vietām.
  5. Pieraksti, ko rīks tev ieteica.

Gatavs, kad: vismaz viens rīka brīdinājums ir pazudis pēc tava labojuma.

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.