Java Code-Konvention

freakjan

Hallo,

ich hab bezgl. der Java Konvention paar Fragen, nachdem ich im Internet gesucht und darüber gelesen und paar Sachen nicht verstanden habe.
Also bitte nicht auf google oder Forumsuche verweisen! Hab schon alles durchgekaut. Danke

Beispiel:

Code

[COLOR=Red]// ist das als Kommentar OK oder sind da überflüssige Zeilen oder fehlt irgendwas wichtiges?[/COLOR]


/**
* Fachbereich Informatik
* Prof.Dr.Mustermann


* Programmiersprache Java
* Objektorientierte Programmierung IV
* Sommersemester 2006
* 30.Marz 2006


* 9.Aufgabenblatt
* 12.Aufgabe (Fehlersuche in Java)


* @autor      Max Mustermann
* @date       11.04.2007
* @version    1.0
*/




public class Beispiel{  [COLOR=Red]//mit oder ohne Leerzeichen zwischen Beispiel und {? [/COLOR]
[COLOR=Red]      //mit oder ohne eine Zeile Abstand?[/COLOR]
    public static double WURZEL (double x, double epsilon) {[COLOR=Red] // also immer, wenn man einen neuen Block anfängt, sollte man dann 4 LeerZeilen einrücken?!? Das bedeutet Blockanfang -> Enter -> dann 4 Leerzeichen -> dann weiter schreiben?![/COLOR]
[COLOR=Red]// soll ich eine Zeile Abstand halten??[/COLOR]
        double fehler, y = x; [COLOR=Red]// soll ich hier nachdem Komma eine Leerzeichen sitzen??[/COLOR]
        [COLOR=Red]// soll ich eine Zeile Abstand halten??[/COLOR]
        do { [COLOR=Red]// soll ich hier zwischen do und { eine Leerzeichen sitzen?[/COLOR]
            y = 0.5 * (y + x/y);
                if (x > y*y ) fehler = x - y*y;  [COLOR=Red]// soll ich zwischen den Operatoren und Operanden einen Leerzeichen sitzen??[/COLOR]
                    else fehler = y*y -x;
        }

        while (fehler > epsilon);
                return y;
    }

    [COLOR=Red]// eine Zeile darf 80 Zeichen nicht überschreiten!!?[/COLOR]
    public static void main (String args[]) {  [COLOR=Red]// soll ich nach main eine Leerzeichen sitzen?[/COLOR]
        System.out.println ("Wurzel con 3.1415 ist " + WURZEL (3.1415, 0.001));
    }

}

Alles anzeigen

Szo

guckst du hier.

auf der page ist auch ein kleines beispiel angefuehrt:

Java

/*
 * @(#)Blah.java        1.82 99/03/18
 *
 * Copyright (c) 1994-1999 Sun Microsystems, Inc.
 * 901 San Antonio Road, Palo Alto, California, 94303, U.S.A.
 * All rights reserved.
 *
 * This software is the confidential and proprietary information of Sun
 * Microsystems, Inc. ("Confidential Information").  You shall not
 * disclose such Confidential Information and shall use it only in
 * accordance with the terms of the license agreement you entered into
 * with Sun.
 */




package java.blah;


import java.blah.blahdy.BlahBlah;


/**
 * Class description goes here.
 *
 * @version 	1.82 18 Mar 1999
 * @author 	Firstname Lastname
 */
public class Blah extends SomeClass {
    /* A class implementation comment can go here. */


    /** classVar1 documentation comment */
    public static int classVar1;


    /** 
     * classVar2 documentation comment that happens to be
     * more than one line long
     */
    private static Object classVar2;


    /** instanceVar1 documentation comment */
    public Object instanceVar1;


    /** instanceVar2 documentation comment */
    protected int instanceVar2;


    /** instanceVar3 documentation comment */
    private Object[] instanceVar3;


    /** 
     * ...constructor Blah documentation comment...
     */
    public Blah() {
        // ...implementation goes here...
    }


    /**
     * ...method doSomething documentation comment...
     */
    public void doSomething() {
        // ...implementation goes here... 
    }


    /**
     * ...method doSomethingElse documentation comment...
     * @param someParam description
     */
    public void doSomethingElse(Object someParam) {
        // ...implementation goes here... 
    }
}

Alles anzeigen

und falls du das ganze für OOP brauchst - unter http://www.complang.tuwien.ac.at/franz/oop06w findest du auch ein paar beispiellösungen an die du dich halten kannst.

JohnFoo

Den Link zu den Code Conventions hast du schon. Bei der Formatierung hilft Eclipse viel: Mit Strg+Shift+F (bzw. Source -> Format) kannst du den Code automatisch nach Konvention formatieren lassen. Mit der Zeit siehst du dann z.B. dass du zwischen einem if/do/for und der Bedingung danach einen Leerraum machen solltest und haltest dich von selbst daran. Weiters Hilfreich sind die diverse Source-Dateien von Sun, die halten sich alle an die Konventionen, da siehst du auch genau wie z.B. Kommentare formatiert werden sollen. Übrigens würde ich Kommentare nie nach einer Zeile schreiben, da dies bei der Auto-Formatierung mit Eclipse ziemlich hässlich wird. Besser du kommentierst über der Zeile. Kürzere Kommentare mit einem //, Kommentare für die Doku mit /** - mehrzeilige Kommentare kannst du zwar mit /* kommentieren, Eclipse unterstützt // aber derart gut, dass man /* nicht braucht.

phudy

1. gute kommentare sind eine eigene (grosse) angelegenheit: guckst du hier.
2. zwischen klassen/methoden-namen und { sehr wohl eine leertaste
3. zeilenabstand zwischendurch macht alles uebersichtlicher/einfacher zu lesen
4. einrueckung ist SEHR WICHTIG (in python ist es sogar bestandteil der sprache), entweder tab oder 2-4 leerzeichen (oder noch besser: editor sagen dass wenn ein tab eingegeben wird er stattdessen 2-4 leerzeichen machen soll)
5. bei "double x, y;" sollte zwischen beistrich und y leerzeichen sein, ja
6. zeilenabstand ist (fast) immer gut, ja
7. bei "do {" leerzeichen, ja
8. bei "y * y" sollte leerzeichen, ja
9. diese 80 zeichen beschraenkung find ich doof, da ich sowohl zuhause als auch in der arbeit einen vieeel breiteren bildschirm hab. 80 sind gut wenn mans mal ausdruckt, aber zum coden ein bissi zu streng. 120-140 ist bei mir normal. aber egal wie breit das maximum ist: maximum ist maximum und darf niemals ueberschritten werden.
10. bei "main (" soll ein leerzeichen sein, ja

schau dir einfach mal checkstyle an. dort sind viele konventionen vorgegeben, du kannst manche ein-/ausschalten und es gibt warnings/errors aus. die dort getroffenen konventionen beantworten alle deine fragen, und noch mehr (zb nach if eine leertaste).

alle angaben sind nach meinen persoenlichen vorlieben und ohne gewaehr.

phudy

Zitat von JohnFoo

Eclipse unterstützt // aber derart gut...

ctrl-shift 7

JohnFoo

Zitat von phudy

ctrl-shift 7

Ctrl+Shift+C verrenkt die Finger nicht so

ghagleit

Ahh danke für die Tips, bin ja quasi ne Wildsau beim coden und die Links helfen hoffentlich in Zukunft

Jetzt mitmachen!