A productionbe szánt kódnak még dokumentációja nincs, nem hogy review
ezen agyaltam meg egy sort, hogy valoban akkora gaz, ha a kodnak nincs dokumentacioja? Ha a termeknek, amit a userek hasznalnak nincs doksija, az tobb, mint gaz.
De pl. nem biztos, hogy egy C++ kodot tele kell szemetelni (szajbaragos) dokumentacioval (amit a vegfelhasznalo ugy sem lat). Egy rovid ideig hasznaltam pl. a pylint nevu lintert, ami kulon sir, ha nincs minden fuggveny alatt rogton ott egy komment, hogy mit csinal az adott rutin. Ezt azert tulzasnak tartom, foleg ha a fuggvenyeknek (meg a valtozoknak is) beszelo nevuk van: eolvasod a nevet, es tudod, hogy (szandek szerint) mit csinal.
Ha van egy hack a kodban, oda el kel a magyarazat, hogy ez most miert, vagy egyeb olyan info, hogy ha fel ev mulva veszed elo a kodot, akkor azok alapjan nem kell sok ido ahhoz, hogy ujra kepbe kerulj, hogy mi tortent, miert igy nez ki a kod...
--
O1G