JSP-develop.de : Basics : Programmierstil

jsp-develop.de | Basics | Programmierstil

5. Februar 2012

Programmierstil Einleitung

Wenn man alleine vor sich hin hackt sind Regeln der Programmierung meist egal, aber nehmen Sie sich mal einen unkommentierten Programmcode vor, den Sie vor einem Jahr geschrieben haben...
Egal wo auch immer Sie Programmcode kreieren, nehmen Sie sich die Zeit bestimmte Konventionen einzuhalten, das wird Ihnen und Ihren Kollegen frührer oder später viel Zeit ersparen. Sparen Sie auch nicht an hilfreichen Kommentaren an den entscheidenden Stellen. Übertreiben Sie es aber auch nicht, denn Kommentare wie i=0; // Variable i auf 0 setzen können auch sehr nutzlos sein, im Gegensatz zu z.B. : } // end while Objekte anzeigen nach dem Ende einer langen Schleife.
Es folgen einige Tipps die die Arbeit erheblich erleichtern sollten...

Java - Tipps zum guten Programmierstil

Benennen Sie die Variablen sinnvoll und so dass man auch sofort Ihren Typ erkennen kann. z.B.:

boolean bErfolg = false;
long lZaehler = 0;
int iDay = 0;
String sWochentag = "";
Vector vElemente = new Vector();

Definieren Sie eine einheitliche Klammerung
Definieren Sie eine einheitliche Einrückung

Javadoc - Der Weg zur guten Dokumentation

Nutzen Sie die Zeit und beschäftigen Sie sich mit javadoc (Bestandteil des JDK), und setzen Sie die speziellen Kommentare gleich beim Schreiben des Java-Sourcecodes ein. Als Belohnung erhalten Sie dann nach Aufruf von javadoc eine umfangreiche HTML-Dokumentation des Codes.
Wie die Kommentierung aussehen muss finden Sie hier : How to Write Doc Comments for Javadoc

Hinweis: Auf dieser Seite liegen Links zu anderen Seiten im Internet. Für alle diese Links gilt: Wir betonen ausdrücklich, daß wir keinerlei Einfluß auf die Gestaltung und die Inhalte der gelinkten Seiten haben. Deshalb distanzieren wir uns hiermit ausdrücklich von allen Inhalten aller gelinkten Seiten auf dieser Homepage und machen uns ihre Inhalte nicht zueigen. Diese Erklärung gilt für alle auf unserer Homepage angebrachten Links

Redaktion/Betreiber von JSP-Develop übernehmen keinerlei Gewährleistung und Verantwortung für die Richtig- und/oder Vollständigkeit von den auf den Webseiten JSP-Develop veröffentlichten Source Codes. Die Verantwortung der Verwendung/Anwendung sowie etwaige Modifikation der hier veröffentlichten Sourcen obliegt einzig dem Benutzer der Webseite, welche die veröffentlichten Sourcen in einer Applikation/Anwendung einsetzt. Durch das Kopieren und/oder Benutzen der Sourcen in einer Applikation/Anwendung bzw. etwaigen Abschriften wird dieser Rechtshinweis anerkannt.

Java, JSP, JavaServer Pages, J2EE, EJB, JDBC, JNDI, JTA, Sun, Sun Microsystems are trademarks or registered trademarks of Sun Microsystems, Inc. in the United States and in other countries. IBM, WebSphere are trademarks or registered trademarks of International Business Machines Corporation. Other trademarks and registered trademarks are the property of their respective owners.