Welcher Name? paintsXY(), isPaintXY(), isPaintingXY() .

[-frank]

ich habe ein problem bei der namenswahl bei methoden. dazu habe ich mal etwas gegooglet:

This is the naming convention for boolean methods and variables used by Sun for the Java core packages.
Using the is prefix solves a common problem of choosing bad boolean names like status or flag. isStatus or isFlag simply doesn't fit, and the programmer is forced to chose more meaningful names.

Setter methods for boolean variables must have set prefix as in:

void setFound(boolean isFound);
There are a few alternatives to the is prefix that fits better in some situations. These are has, can and should prefixes:

boolean hasLicense();
boolean canEvaluate();
boolean shouldAbort = false;

quelle: http://geosoft.no/development/javastyle.html#General

Use the prefixes get and set for getter and setter methods. Getter methods merely return the value of a instance variable; setter methods change the value of a instance variable. For example, use the method names getBalance and setBalance to access or change the instance variable balance.

If the method returns a boolean value, use is or has as the prefix for the method name. For example, use isOverdrawn or hasCreditLeft for methods that return true or false values. Avoid the use of the word not in the boolean method name, use the ! operator instead.
For example, use !isOverdrawn instead of isNotOverdrawn.

quelle: http://www.cwu.edu/~gellenbe/javastyle/method.html

---

mir ist nun weiterhin nicht ganz klar, wie ich getter methoden für boolean variablen benennen sollen, wenn diese keinen zustand à la "isReady()" oder "isVisible()" beschreiben, sondern etwas, was die Klasse tut.

angenommen ihr habet ein speziellen GUI objekt, das ein fussball-feld darstellt und ihr wollt ein/auschalten können, ob das spielfeld gezeichnet wird.

paintsField()?
isPaintField()?
isPaintingField()?
...

und nennt ihr dann die variable und die setter Methode entsprechend?

oder würdet ihr die methode ganz umbenennen? etwa in setVisibleField() und hasVisibleField() oder sowas wie
setFieldIsVisible() und isFieldVisible()?

stoße auf auf solche bze. ähnliche situationen, wo mir dann nicht ganz klar ist, wie ich die methode am besten nennen sollte.

 

[kleiner_held]

private boolean fieldVisible;
public boolean isFieldVisible() {...
public void setFieldVisible(boolean fieldVisible) {...

// oder

private boolean fieldPainted;
public boolean isFieldPainted() {...
public void setFieldPainted(boolean fieldPainted) {...

Ich halte es fuer wichtig, dass die Namenskonventioen der JavaBeans eingehalten werden, damit man dann, wenn man mal ein Framework ala BeanUtils verwendet, nicht in Verlegenheit kommt alles wieder umzubenennen.

PS: an sich finde ich es absolut besch**, dass Sun bei den Bean Konventionen fuer boolean eine Extrawurst eingefuehrt hat.

 

[Campino]

setFieldVisible() und isFieldVisible(). Wobei ich annehme, dass die Klasse das Field ist, man also mit isVisible() bzw. setVisible() auskommen würde. Da die Methode zur Spielfeld-Klasse gehört, ist klar, dass es sich auf das Field bezieht.

 

[-frank]

danke euch beiden!

setFieldVisible() und isFieldVisible(). Wobei ich annehme, dass die Klasse das Field ist, man also mit isVisible() bzw. setVisible() auskommen würde. Da die Methode zur Spielfeld-Klasse gehört, ist klar, dass es sich auf das Field bezieht.

ja, in dem fall hätte man sicher eine eigene klasse für das feld. es könnte aber für andere objekte trotzdem interessant sein, ob das feld angezeigt wird (warum auch immer - ist ja nur ein beispiel) und dann hätte man eine methode wie

public boolean isFieldVisible() {
    return getField().isVisible();
}

okay, also is + subjekt + verb bzw. eigenschaft. und keine -ing form.

also würdet ihr sagen, dass es generell besser ist, wenn man sich an ein schema hält als wenn man nur drauf schaut, dass es gut klingt, oder? (ich persönlich hätte ja auch nix dagegen, wenn alles nach get/set-schema benannt wäre...)

 

[kleiner_held]

Ein einheitliches Schema im Projekt sollte man schon einhalten - ansonsten ist die Namenswahl allgemein ein Ausdruck des persönlichen Stils. Man sollte versuchen aussagekräftige Namen zu finden, aber naja da gibt es auch unterschiedliche Prioritäten. Ich verwende bei Klassen lieber lange Bezeichner um kein Missverständniss aufkommen zu lassen, andere sagen, dass sie mit einem 40 Zeichen langen Klassennamen nix anfangen können. Bei Variablen- und Methodennamen ist das entsprechend.
Das isXYZ() Schema wurde auch nur deswegen eingeführt, weil boolean Attribute oft in einer Bedingung abgefragt werden und ein if(frame.isVisible()) ist halt eingängiger als if(frame.getVisible()). Ich finde es trotzdem blöd