Name der Klasse nicht in der Methode wiederholen
Nehmen wir an, wir haben eine Klasse die Strings in einer Collection sammelt. Ein solche Klasse würde natürlicherweise StringCollection heissen. Diese Klasse hätte, wie jede vernünftige Collection, eine add und remove Methode.
Nur, wie nennt man diese Methoden? add oder addString? remove oder removeString?
Die Antwort lautet für mich ganz klar: add.
Die Wiederholung von String in addString wiederholt nur die Tatsache, dass es sich um eine Collection von Strings handelt - durch den Namen StringCollection wurde dies aber bereits gesagt. Weshalb sollte man das in der add Methode wiederholen wollen? Zumal der Parameter dieser Methode wohl ebenfalls einen String entgegen nimmt.
Es kommt erschwerend dazu, die Erfahrung hat mir es gezeigt, dass solche Namen nur in der ersten Version der Klasse stimmen. Nehmen wir an, die Klasse wird von StringCollection in CharsequenzeCollection umbenannt. Es gibt nun Leute die aus Stress oder Lässigkeit vergessen, die Methoden anzupassen. Aus addString müsste ja addCharsequenze werden. Natürlich müsste auch der JavaDoc nachtragen.
Nur, wie nennt man diese Methoden? add oder addString? remove oder removeString?
Die Antwort lautet für mich ganz klar: add.
Die Wiederholung von String in addString wiederholt nur die Tatsache, dass es sich um eine Collection von Strings handelt - durch den Namen StringCollection wurde dies aber bereits gesagt. Weshalb sollte man das in der add Methode wiederholen wollen? Zumal der Parameter dieser Methode wohl ebenfalls einen String entgegen nimmt.
Es kommt erschwerend dazu, die Erfahrung hat mir es gezeigt, dass solche Namen nur in der ersten Version der Klasse stimmen. Nehmen wir an, die Klasse wird von StringCollection in CharsequenzeCollection umbenannt. Es gibt nun Leute die aus Stress oder Lässigkeit vergessen, die Methoden anzupassen. Aus addString müsste ja addCharsequenze werden. Natürlich müsste auch der JavaDoc nachtragen.
 |
Der Name der Klasse, oder ein Teil davon, sollte nicht bei den Methodenamen wiederholt werden. |
Kommentare
Warning: The magic method __isset() must have public visibility and cannot be static in /home_pr1/r/a/rabbithole.ch/htdocs/_php/Zend/Config.php on line 181
Warning: The magic method __unset() must have public visibility and cannot be static in /home_pr1/r/a/rabbithole.ch/htdocs/_php/Zend/Config.php on line 193
Warning: The magic method __call() must have public visibility and cannot be static in /home_pr1/r/a/rabbithole.ch/htdocs/_php/Zend/Db/Select.php on line 1056
copyright by morpheus, website powered by 