Kouzla komentářů

9.2.2006 11:48 | Přečteno: 1372× | Linux

O tom že je rozumné psát komentáře do zdrojových kódů snad nikdo nepochybuje. Statistiky různých sprostých slov jsou již dlouho známé, ale přesto občas při opravování cizího kódu člověk narazí na zajímavé perly, které opravdu pomou k pochopení kódu.

Třeba po přečtení následujícího vysvětlení v gcc je hned jasné na co že se tato hodnota používá:

          // ??? Completely unknown what this field is supposed to be for.
          // ??? Need to cache TType encoding base for call_unexpected.
          xh->catchTemp = landing_pad;

Přece není možné, aby programátoři nevěděli co píší. Ale když už se v tom gcc hrabu, tak grep na tři otazníky najde další zajímavé komentáře:

  /* ??? When is this needed?  */
  saved_function = current_function_decl;

  /* If we are supposed to return TEMP, do so as long as it isn't a MEM.
     ??? The latter test doesn't seem to make sense.  */
  else if (dont_return_target && GET_CODE (temp) != MEM)
    return temp;

Nejdůležitější je ale stejně sebereflexe a schopnost zhodnotit kód:

              /* ??? this interface is stupid - why require a pointer?  */
              result = gen_reg_rtx (Pmode);

Taky tvoříte takovéto komentáře?

       

Komentáře

[Michal Kubeček]

IMHO takové komentáře obvykle nepíše autor příslušní části zdrojáku, ale ten, kdo ji po několika letech zdědil a některé obraty není schopen dešifrovat.

[Michal Čihař]

Jasně, nejspíš to tak bude (CVS jsem neprohledával, za tolik námahy mi to nestojí ).

[Non_E]

Aby to nebyl autor, co se snaží zpětně sepsat komentáře k výsledkům svého celonočního snažení. Občas se stane, že člověk takhle napíše něco co funguje, ale jak funguje, to už neví.

[Michal Kubeček]

Když neví, jak to funguje, neví ani jestli to funguje. Empirickým programátorům píšícím metodou pokus-omyl bych naplácal přes ruce a poslal je dělat nějakou práci, kde nenapáchají tolik škody.

[xkesh]

Empirickým programátorům píšícím metodou pokus-omyl bych naplácal přes ruce a poslal je dělat nějakou práci, kde nenapáchají tolik škody.

Treba do politiky :P

[jiri]

No úplně pravda to zas není. Píšu program na vektorizaci bitmap a těch věcí co ovlivňujou výsledek je tolik, že se to někdy opravdu nedá napsat jinak než metodou pokus omyl. Normální člověk prostě nedokáže pojmout tolik vstupních faktorů. Pravda nakonec vím co ten program dělá, i když je tu možnost že mi něco uniká.

[Michal Kubeček]

To je ovšem dost specifický případ, který tak úplně nezapadá do toho, o čem jsme se tu bavili.

[Jiří (BoodOk) Kadeřávek]

No dnes vim, za rok nevim. Myslim, ze tohle muze byt naprosto normalni pripad. Pokud te nekdo nebo neco donuti okomentovat dodatecne kod, tak muze byt problem, pripadne casove velmi narocne, si zpetne vsechny souvislosti vybavit. Myslim, ze tyto komentare s metodou pokus omyl vetsinou nesouvisi. Rekl bych totiz, ze empiricti programatori nekomentuji. Neni totiz co

[Hrabosh]

Tenhle post mi připomněl, jak sem musel před vystavením na Internetu mírně předělávat svůj program v ASSEMBLERu, protože původně jsem příznak dělení nazval PrDel a pokud došlo při výpočtu k přetečení, volala se část programu, zvaná 'JeToVPrdeli'.

Z.H.

[Michal Kubeček]

V příznaku dělení? :-)

[Hrabosh]

Noooo...né tak úplně :o)

Myslel jsem spíš to místo, kam slunce nesvítí :o)

Z.H.

[Michal Kubeček]

To je to místo kdesi v Lancre? :-)

[Hrabosh]

Spíš sem myslel to místo, kde končí záda a začínají nohy :o)

Z.H.

[Leoš Literák]

Jeden byvaly kolega mel v bugzille uzasnou serii. Nejdrive si nareportoval bugu, pak se sam sebe zeptal, kdy to muze nastat, odpovedel si, ze netusi a nakonec si ji uzavrel jako invalid

[Jiří (BoodOk) Kadeřávek]

Uz se mi stalo, ze mi kdosi mailem reportoval nejaky problem, v prubehu emailu to rozebral, na konci vyresil, ale kdyz uz to sepsal, tak mi to i poslal. Bud to bylo mimodek, nebo aby bylo videt, ze si s tim dal tu praci