Ko komentiraš kodo, bodi pozorna da ne pišeš komentarjev oblike:
for i in range(10): # s to zanko gremo po indeksih od 0 do vključno 9
if i == 5: # preverimo če je indeks 5
print("i == 5") # izpišemo "i == 5"
break # prekinemo zanko
saj te komentarji samo z besedo opišejo kaj dela ta vrstica, torej so čisto odveč. Bolj smiselno je, da napišeš idejo problema. Narpimer:
# z zanko bomo preverili če je kakšno število med 0 in 9 enako 5.
# Če ga bomo našli, bomo zanko prekinili, saj bomo s tem izboljšali učinkovitost
Torej pri tebi konkretno, v primeru akcija, morda napišeš, zakaj preprosto ne preveriš vseh možnosti, komentiraš kaj imaš v kakšni spremenljivki s kakšnim razlogom. Komentar mora biti napisan tako, da vsak ki je seznanjen s sintakso pythona, razume kaj koda dela. Dobra praksa je, da na vrhu napišeš idejo naloge, da bo bralec vedel kaj koda počne v onsovi. Če pa pišeš funkcije, pa priporočam, da v vrstico pod definicijo funkcije napišeš v trojne narekovaje kaj funkcija počne. Naprimer:
def prastevila(a, b, n):
"""sprejme: tri naravna stevila a, b in n
vrne: najvec n zaporednih prastevil med a in b
a ... spodnja meja
b ... zgornja meja
n ... najvecje dovoljeno ctevilo practevil"""
# koda, ki to dejansko naredi ...
Na tak način lahko potem pokličeš help(prastevila) in ti izpiše točno to, kar je med tremi narekovaji. Tako se potem ve kaj funkcija dela, tudi po treh mesecih. Kako dela, pa se piše s sprotnimi komentajri. Če uporabljaš kakšen znan algoritem, lahko navedeš le ime algoritma npr. uporabimo Eratostenovo rešeto.
Koda mora biti pokomentirana do te mere, da če te nekdo vpraša kaj pa tole dela, da znaš brez da pretirano razmišljaš odgovoriti na vprašanje.
Upam, da vsaj približno pomaga. Konkretnih komentarjev za tvojo prej objavljeno kodo, pa žal ne smemo pisati.
