Registriert seit: 23. Sep 2002
Ort: Frankfurt am Main (in der Nähe)
1.840 Beiträge
Delphi 10 Seattle Enterprise
|
AW: Was gehört alles in eine richtige Dokumentation?
12. Dez 2013, 17:04
Also, ich würde mal sagen, der Name 'SetEnabledRec' ist Schrott. Im Clean-Code sollte er so heißen (z.B.):
SetEnabledOfChildControlsOnForm(aForm : TComponent; aParentControl : TControl; aValue : Boolean);
Wozu also jetzt noch Kommentare?
Ich möchte dazu nur folgendes sagen: - Hat r2c2 das in seinem sehr ausführlichen Beitrag schon wirklich nett erklärt.
- In Deinem Namen nicht erkennbar ist, dass rekursiv die Eigenschaft Enabled aller untergeordneten Elemte gesetzt werden.
- Habe ich geschrieben, warum das so ist, und ich auch nicht glücklich damit bin.
- Werden die Kommentare zur Erstellung der Dokumentation verwendet.
Und ich bin immer noch der Meinung, dass in der Beschreibung einer API auch eindeutige Funktionen dokumentiert werden sollten.
z.B. die Funktion abs()-> http://docwiki.embarcadero.com/Libra.../de/System.Abs
(°¿°) MaBuSE - proud to be a DP member
(°¿°) MaBuSE - proud to be a "Rüsselmops" ;-)
Geändert von MaBuSE (12. Dez 2013 um 20:49 Uhr)
|