Zitat von
Luckie:
Delphi-Quellcode:
Input: aChar - The char to be checked
* mode - if TRUE, '*' is allowed
Umbenennen der Parameter macht den Kommentar überflüssig: CharToCheck, AllowWildCards.
Da muß dann aber auch gleich die Erläuterung, welche Wildcards gemeint sind, dazu kommen.
So wird nur ein Zeichen zur "Wildcard" erklärt.
Zitat von
Luckie:
Delphi-Quellcode:
Output: 0 - The character is acceptable
* 1 - The char is a lower case letter
* 2 - Unacceptable char
* 3 - A space character
Verwendetman einen Aufzählungsdatentyp mit sprechenden bezeichnung, ist auch dies überflüssig.
Overview: Checks to see if a char is acceptable in short format
Bessere bennnung der Funktion macht auch dies überflüssig.
Wenn ich mich richtig erinnere, basiert das Beispiel auf einem C-Quelltext und da ist es mit den Aufzählungstypen wohl nicht so weit her. Zumindestens in älteren Programmen ist das wohl eine reine Pascal-Errungenschaft.
Im Prinzip finde ich so einen "Header" ganz gut weil:
ein "Sprachfremder" findet sich besser zurecht, weil er im Klartext erfährt was sich in der Funktion versteckt.
wenn man einen solchen "Header" erstellt, dann ist man gezwungen sich ein paar Gedanken über die erwünschte Funktionalität zu machen, da fallen oft irgendwelche Schludereien auf.
Gruß
K-H