🚀 go-pugleaf

Das man Fehlertexte

a) direkt im Source
b) in einem Fehlermodul
c) in einer Fehlerdatei

hinterlegen kann, ist mir klar. Nur m�ssen die Dinger ja auch irgendwo
dokumentiert werden. Leider wollen viele Anwender immer noch ein gedrucktes
Buch. Gibt es bessere Techniken als folgendes?

error.txt
---------
1001 file %1 not found
1002 no space left
1010 out of range
2007 %1 ist gerade %2
...  ...

work.cc
-------
if(...) printError(1010);

Doku
----
Fehler 1001:
Die Datei wurde nicht gefunden. Pr�fen Sie, ob ...
Fehler 2007:
Tun Sie die oder das

Was mich an dieser L�sung st�rt, ist die feste Vergabe von Nummern. Einerseits
sollte man die logisch gruppieren, aber andererseits wird Murphy zuschlagen
und der Bereich von 1001-1009 reicht f�r die Klasse von I/O-Fehlern nicht
aus. Au�erdem habe ich wenig Lust st�ndig nachzuschlagen, welche Nummer ich
f�r welchen Fehler vergeben habe. Also lassen wir die Zahlen weg und nehmen
K�rzel:

error.txt
---------
NOFILE   file %1 not found 
NOSPACE	 no space left     
BADRANGE out of range      
AISJUSTB %1 ist gerade %2

error.h
-------
enum {NOFILE,NOSPACE,BADRANGE,AISJUSTB}

work.cc
-------
if(...) printError(BADRANGE);

Doku
----
Fehler NOFILE:
Die Datei wurde nicht gefunden. Pr�fen Sie, ob ...
Fehler AISJUSTB:
Tun Sie die oder das

Bei vielen Fehlermeldungen wird es schwierig kurze, pr�gnante Namen zu finden.
Viel schwerwiegender ist die Sortierung der Meldungen in der
Dokumentation. Macht man es alphabetisch stehen v�llig verschiedene Meldungen
beieinander. Gruppiert man die Meldungen, braucht man noch einen Index damit
der Benutzer die Meldung finden kann. Der mu� dann allerding 2x pro
Fehlermeldung nachschlagen.

Mir schwebt irgendeine L�sung mit Exceptions vor. Ich frage mich nur, wie man
den Kram dann m�glichst einfach dokumentieren kann. Redundanzen mag ich gar
nicht gerne per Hand pflegen. Da gibt es doch sicherlich eine elegante L�sung,
die ich wahrscheinlich nur noch nicht kenne.

Wer kann mir zu dem Thema Informationen oder Quellen nennen?

Thorsten
-- 
=============================================================================
Thorsten Gau --- Neu Wulmstorf, Germany --- VOICE: +49 40 / 700 12 18 4  * * 
EMail: gau_t@gauhh.hanse.de / gau_t@users.informatik.fh-hamburg.de        |  
2B or not 2B... gives FF    / finger me for PGP-Key                     \___/