Mein Delphi-Style

[stoxx]

mal auch eine andere Frage, ich habe mir schon länger und immer mal wieder vorgenommen, vor jeder Funktion eine eindeutige Erklärung zu schreiben, sowas in der Art.
Schafft ihr das durchzuhalten? die Mühe ist es sicherlich wert, aber bei kleinen Funktionen lässt man es dann und irgendwann steht vielleicht oft nur noch kurz da, was die Funktion macht, sonst nix ...

(das ist jetzt mal ein Beispiel aus einem C Quelltext, den ich aber gut fand)

Delphi-Quellcode:

{==============================================================================
*   Function:        BYTE isShort (char aChar, BYTE mode)
*
*   PreCondition:    None
*
*   Input:           aChar   - The char to be checked
*                    mode    - if TRUE, '*' is allowed
*
*   Output:          0       - The character is acceptable
*                    1       - The char is a lower case letter
*                    2       - Unacceptable char
*                    3       - A space character
*
*   Side Effects:    None
*
*   Overview:        Checks to see if a char is acceptable in short format
*
*   Note:            None
==============================================================================}