Protected Classes/Members

[tincup]

Hi.

Schreibe grad an ner Bibliothek, die dann mit JavaDoc und vor allem einsichtig und bedienbar ausgeliefert werden soll.
Würde gerne mal eure Meinung zu protected Klassen und Members hören.

Und zwar habe ich ein paar Klassen in den Paketen, welche einfach nicht vom User benutzt werden sollten. Sie sind Hilfsklassen für ein oder zwei "echte" Klassen, hätten mir aber als innere Klassen den Code völlig überfrachtet.
Ähnliches gilt für bestimmte Methoden, die der Benutzer eigentlich nicht aufrufen sollte bzw. ihm nur schwer verständlich zu machen wäre, warum und wie er das tun sollte.

Jetzt ist mir klar, dass protected ja nicht wirklich etwas vor dem Benutzer versteckt, sondern nur im entsprechenden Scope nicht ansprechbar macht.

Wäre jetzt so vorgegangen, dass ich protected members einfach im JavaDoc gar nicht mit exportiert hätte. Beim Betrachten anderer JavaDocs scheint das aber nicht der übliche Weg zu sein, oder?!

Grüsse,
Tin

 

[Tobias]

protected muß mit exportiert werden, weil jemand, der zur Erweiterung deiner Bibliothek diese Member überschreiben will, sonst völlig ohne Dokumentation dasteht. Wenn du partout nicht willst, das deine Member überschrieben werden, mach sie nicht protected sondern private oder package-private. Die müssen dann auch nicht dokumentiert sein (ich tu es trotzdem, aber mehr für mich selbst). Vom Standpunkt einer veröffentlichten Bibliothek ist es vielleicht sogar sinnvoll zu sagen, dass private und package-private Member nicht dokumentiert sein sollten, von wegen Kapselung und Information Hiding. Da kann man aber sicher drüber streiten.

mpG
Tobias

 

[tincup]

Ah mir war nicht mehr bewusst, dass kein Modifier ja auch eine ganz eigene Funktion hat (package-private eben). Wen's noch interessiert:

http://java.sun.com/docs/books/tutorial/java/javaOO/accesscontrol.html

Danke schonmal, hat mir genau den richtigen Anstoss gegeben.

Vom Standpunkt einer veröffentlichten Bibliothek ist es vielleicht sogar sinnvoll zu sagen, dass private und package-private Member nicht dokumentiert sein sollten, von wegen Kapselung und Information Hiding. Da kann man aber sicher drüber streiten.

Würde ich unbedingt so sehen. Wie ich ja schon beschrieben hatte sind meine Hilfsklassen eher Konstrukte für mich und wenig sinnvoll für andere. Mag jetzt ein schlechtes Klassendesign zugrunde liegen oder nicht, aber anders hauts momentan nicht hin. Wenn man alles dokumentiert geht eben die Kapselung den Bach runter.