Újabb csodálatos dokumentáció...

...amit olyanok írtak, akik azt hitték, a DoxyGen által generált semmitmondó vacak automatikusan egyezik a tökéletes fejlesztői dokumentációval.

Példa:
http://pocoproject.org/docs/Poco.NotFoundException.html

Igen. És mi dobja? Mikor? Miért?

Hozzászólások

talan azert semmitmondo, mert SEMMI commentet nem irtak bele...
a Doxygen egy nagyon ugyes es hasznos eszkoz, de nem fogja magatol kitalalni hogy egy osztaly mire es hogyan valo, nem MI hanem egyszeru parser/converter...

Nem a doxygent szidom. A mentalitást. Hogy sokan azt hiszik, elég, ha lefuttatják, komment nélkül.
Egyébként meg mi tartja vissza a DoxyGen-t, hogy ha már végigmegy a forráson, akkor legalább megnézze azt is, milyen osztályok dobják ezt az adott kivételt? Nem látom, hogy lenne elvi korlátja, dinamikusan nem generálunk kivételt...

Remélem, lesz olyan helyzeted, amikor a rendkívül informatív "not found" exceptionnal lép ki egy bonyolult könyvtár valamelyik függvénye, és debugolhatod, hogy mi az, ami nem talál valamit és mit nem talál.
Szerintem egy dokumentációnak igenis része, hogy egy adott függvény milyen hibás esetekez jelez és mivel. Innentől kezdve meg a visszafele hivatkozás automatikus legenerálása nem kéne gondot okozzon.

Ezt nem az Exception-nél kell dokumentálni, hanem a bonyolult könyvtár valamelyik függvényénél.
Nem a kivétel dolga tudni, ki fogja őt dobni (például a saját kódod is dobhatja).
"Innentől kezdve meg a visszafele hivatkozás automatikus legenerálása nem kéne gondot okozzon."
Ez csak az adott liben belül lenne értelmes, máskor nem. Azaz a dokumentáció nem írja le akkor sem az igazságot, és a dokumentációkról egy biztos: a rossz, pontatlan dokumentáció rosszabb, mint a nem létező dokumentáció.

> Ez csak az adott liben belül lenne értelmes, máskor nem. Azaz a dokumentáció nem írja le akkor sem az igazságot, és a dokumentációkról egy biztos: a rossz, pontatlan dokumentáció rosszabb, mint a nem létező dokumentáció.

Magyarul az adott lib dokumentációja tartalmazhatná...

Egyébként megjegyzem: annál a függvénynél amelyik elhasal sincs feltüntetve, hogy ez micsoda, mi okozza, mi hiányzik neki.

Igen.
Poco dobja.
Ha rafut a vegrehajtas.
Mert not found.

Bocs, nem birtam kihagyni.

Ha lattal ilyet dobva akkor jo esetben van melle stacktrace.
grep gyorsabb, mint blogolni.

+ kulon orom, ha valaki elvraja, hogy a generalt docbol tudni fogom, hogy hash/map/dict parameter, milyen kulcsokat var es azok mit jelentenek. Sajnos erre legtobbszor egy grep nem eleg.

Amit nem lehet megirni assemblyben, azt nem lehet megirni.

Hibalehetőséget nem könnyű előhozni (+ sokat fut addig a program), ezen kicsit bekavar. Hiába futtatom pl. GDB-vel, ha
1.) nem jön elő a probléma (van ilyen sajnos, és ebben a programban több ilyet is találtam)
2.) vagy hosszabb idő, míg a probléma előjön (akár fél nap is :-( )

Ilyen esetben jó lenne, ha lenne értelmes dokumentáció erről. Elismerem, kicsit egzotikus a problémám, de azért az a what() szöveg, hogy "not found" kicsit szíven ütött :-(.