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

"ha egy fgvnek túl sok a paramétere"

Félreértetted, pl. C-ben akár egyetlen paraméter is lehet olyan típusú, csak csak egy adatot tartalmaz, mégis vakarhatod a fejed, hogy az mi.

"én dolgozom a legnagyobb kódbázison"

Akkor mégis milyen választ szeretnél kapni? Miért tetted fel a kérdést, ha belekötsz a válaszokba?

"Az értékes gondolatokra vagyok kíváncsi"

Ahogy látom, ez egy sima provokatív kérdéssé vált, a trolloktól függetlenül is.

Ha már te dolgozol a legnagyobb kódbázison (LOL x LOL):

Akkor a 15-ösben elejtett apró kódrészt magyarázd már el nekünk, ha lehet.

"Ja ma már a világon minden provokáció"

A kérdés elég rosszul lett feltéve...A kommentelés nagyban függ a nyelvtől.

Alacsonyabb szintű nyelvekben divat okádék kódot írni így ott szükséges lehet az intenzív kommentelés.

Viszont pl. Java-ban divat olvashatóan kódolni és ciki a sok komment.

Általános három esetben írunk kommentet:

- Valamihez magyarázat, hogy MIÉRT van ott és úgy megvalósítva (Soha nem arról, hogy hogyan van megvalósítva)

- Magyarázat a maguktól nehezen olvasható részekhez: pl regex-ekhez példák, stb.

- Dokumentációs komment publikus metódusokhoz (Javadoc)

És nincs több eset. (Java) Ha más eset miatt szükség érzed a kommentelésnek, akkor szar kódot írtál.

A clean code c. könyvet érdemes olvasni és a leírt dolgokat megfontolni és betartani, ha érthető és karbantartható kódot akarsz írni.

Egy szép kódban percek alatt bármit meg lehet találni, még akkor is, ha más írta.

Huuuhh :) Ezt a sok kommentet végig nem olvasom, de amikor azt írtam, hogy a kódnak jólérhetőnek kell lenni és felesleges a komment, akkor nem azt mondtam, hogy én soha sem kommentelek.

Láttam már olyan kb kb 500 soros függvényt, ami tele volt, "j, k, l, m, o p" mindenféle semmit mondó változóval, amik nem kicsi scopeú semmire használatos változók voltak, hanem fontos a megértés szempontjából. Meg olyan kicsivel normálisabb, de még mindig érhetetlen nevekkel mint "countA" ... de mi a f... az az "A".

Ilyen kód dzungelekben elengedhetetlen, de aki képes normálisan programozni és kódot olvasni, annak csak speciális esetekben kell.

Szerintem minden épkézláb projektben van komment.

Még magamnak is szoktam, mert nem egyszer fordult elő, hogy szépen kiagyaltam magamnak valamit, működött is a program, de aztán félretettem és amikor 1-2 hónap múlva ismét elővettem, akkor meg csak pislogtam, hogy mi miért is van úgy ahogy. Pedig saját magam raktam össze, pár hónap után mégis elfelejtettem aztán bogarásznom kellett.

Na ezért IS kell a komment.

Megkönnyíted a saját magad illetve mások munkáját is.

Legyen rövid, de deszkriptív.