Ti szoktátok kommentelni a kódotokat? Miért igen és miért nem?

"Egy jól megírt kódnak értelmetlen kommentet adni, mert első ránézésre megérteti, hogy mit akar csinálni."

Ez tipikusan a szivatás kategória. Pl. ha van egy függvény vagy metódus, akkor mindenki bogarássza át, hogy milyen paraméterek értékeket fogad el, mitől függően mit ad vissza, milyen egyéb változásokat okoz pl. egy objektumon, stb. Főleg, ha ez meghív még húsz másik függvényt.

Igyekszem a kódomot úgy szervezni és a dolgokat elnevezni, hogy érthető legyen.

Vannak esetek, amikor kell comment is mellé: pl ha valami nem szokványos megoldást alkalmazok oda szoktam írni, hogy miért azt választottam. Ezen kívül pl. a DoxyGen commenteket a legtöbb project megköveteli.

De ennyi. A

//Delete markers

markers.delete()

jellegű kommentektől frászt kapok.

"Erre lehet úgy is válaszolni, hogy akinek nem érthető a kódja az ne is programozzon."

Erre meg lehet úgy is válaszolni, hogy a hello world-nél azért léteznek bonyolultabb programok is.

InLoop:

mov ah, 00h

int 16h

cmp al, 48

jl strt

cmp al, 57

jg strt

mov [bx], al

mov dl, al

mov ah, 06

int 21h

inc bx

add [cnt], byte 1

cmp [cnt], byte 4

je MkIntVal

jmp InLoop

Igen, most ez mondjuk környezet és nyelv függő is, mert pl. embedded környezetben nem túl optimális a sok függvény hívás. Bár ott meg ott van az inline function meg a makró.

De magasabb szintű nyelven pl az egymásba ágyazott ciklusoknál:

a) sokat segít ha a ciklusváltozó nem i,j,k stb., hanem rowIndex, columnIndex, characterIndex etc. Máris egyértelmű mi micsoda.

b) ha komplikáltabb a ciklusmag akkor kiteszed külön függvénybe, így lesz egy ciklus ami bejárja a sorokat és mindre meghívja a processRow függvényt. stb.

Ami a paramétereket illeti:

objektumorientált környezetben ha egy fgvnek túl sok a paramétere átalakítod classá, vagy a paramétereket egy structban adod át és máris olvashatóbb.