Allerlei zum Praktikum Softwaretechnik - Vertiefung

Abgabe, die 2.

• Use-Case-Diagramm + Beschreibung
• Klassendiagramm + Beschreibung (beide Diagramme und Beschreibungen bitte an den aktuellen Projektstand anpassen !)
• Programm (entweder als EAR-Datei, oder ich hole es mir aus dem Subversion)
• Technische Doku die mir erklärt wie ich es zum Laufen bekomme: Konfiguration (und eventuell Erstellung) des Loginmoduls, Initialisierung der Datenbank, ...)
• Benutzerhandbuch. Das könnt ihr z.B. als HTML-Seite in eure Anwendung integrieren.

• Jede Klasse und jede Methode sollte einen ausführlichen Javadoc-Kommentar haben, der die Funktion erklärt. Für die Klassenkommentare könnt ihr die Beschreibungen aus den Klassendiagrammen klauen.
  Sind die Kommentare zu bescheiden gibt das Punktabzug.
  Ihr könnt euch von Eclipse helfen lassen indem ihr die Javadoc-Validierung einschaltet:
  
  
  
• Prüft euren Code ob er den offiziellen Java-Coding-Konventionen von Sun entspricht. Die findet ihr hier. Interessant ist Kapitel 9 ("Naming Conventions").
  
  
• Packages: sollten immer die Form "Top-Level-Domain.Organisation/Firma.Produkt" haben und erst danach weiter verzweigen. Beispiel: de.fhw.onlinebanking oder org.apache.tomcat oder org.jboss.ejb3 oder com.ibm.websphere. Ihr erkennt das Prinzip ;-) ?
  Alle Klassen eures Projekts sollten im gleichen Haupt-Package liegen, aber pro Projekt verzweigen. Z.B. de.fhw.onlinebanking.ejb.entity, de.fhw.onlinebanking.ejb.session, de.fhw.onlinebanking.servlet, de.fhw.onlinebanking.unittest und so weiter.
  
  
• Klassen: beginnen mit Großbuchstaben, jedes neue Wortteil bekommt wieder einen Großbuchstaben. Bankbean wäre also falsch, BankBean richtig. Das Verfahren heißt "Camel Casing": http://en.wikipedia.org/wiki/Camelcase. Bei Klassennamen ist auch der erste Buchstabe groß, diese Sonderform wird bei Microsoft "Pascal Casing" genannt.
  
  
• Methoden und Variablen: erster Buchstabe ist kleingeschrieben, der Rest des Wortes ist im Camel Casing gebaut: findepersonzuname ist böse, findePersonZuName richtig.
  
  
• Mit dem Refactoring von Eclipse könnt ihr Änderungen ziemlich einfach durchführen: rechtsklick im "Project Explorer" auf eine Klasse oder Methode und "Refactor" -> "Rename" auswählen. Eclipse führt die Änderung jetzt im gesamten Programmcode durch.

Beispiele:

Links:

Literatur:

Richard Monson-Haefel, "Enterprise Java Beans", 5. Edition, 730 Seiten, bei O'Reilly erschienen. ISBN (englische Version): 0-596-00978-x http://www.oreilly.com/catalog/entjbeans5/index.html

Heiko W. Rupp, "JBoss - Server-Handbuch für J2EE-Entwickler und Administratoren", 350 Seiten, im "dpunkt.verlag" erschienen. ISBN: 3-89864-318-2 Eignet sich nicht zum EJB-Lernen, sondern mehr für die Grundlagen des JBoss. Ist leider auf dem Stand von J2EE 1.4 http://www.dpunkt.de/buecher/3-89864-318-2.html