Conventionen

[e9926044]

Hi,

habt ihr in eurer Firma code conventions bzw. welche.
Wir haben vor kurzem eine Liste eingebührt aber die ist sehr kurz (immutable objekte, keinen finalizer, equals methode soll reflexve usw sein, immer toString überschreiben)
Was würdet ihr noch in den codeconventions reinschreiben?

 

[maestr0]

Eine gewisse Grenze der zyklomatischen Komplexität,Methodenlänge etc....

 

[Gast2]

- Keine TABS, sondern z.B. 4 Leerzeichen
- Hinweis auf die allgemeinen Java Conventions (CamelCase ect.)
- Klammerregeln
- Eventuell auch einfach die passenden Preferences für die verwendete(n) IDE zur Verfügung stellen.

 

[PeterS]

- Keine nicht genutzten imports
- Anzahl Übergabeparameter in Methoden begrenzen
- Zeilenlänge begrenzen
- Javadoc Kommentar zu jeder Methode (zumindest zu den public)

 

[schalentier]

- Javadoc Kommentar zu jeder Methode (zumindest zu den public)

Wuerd ich so nicht machen, sonst entstehen Hunderte Kommentare im Stil von:

/**
 * This method sets the name
 */
public void setName( String name ) {
   this.name = name;
}

 

[c_sidi90]

methodcomments find ich aufjedenfall auch notwendig, das pflegen wir auch so, bei den gettern & settern lassen wir die in der Regel auch weg.

 

[Pippl]

- Zeilenlänge begrenzen

Auf einen fixen Wert ala 80 Zeichen wie in Pli oder halt "nach Gefühl" (überlange ifs oder string verkettungen z.b)

 

[maki]

JavaDoc sollte Dokumentation sein,

aber wenn die JavaDoc keine Informationen hinzufügt, welche zB. nicht schon aus der Methodennamen, Parameter und Rückgabewert ersichtlich sind, dann ist JavaDoc keine Dokumentation sondern schlicht überflüssiger Text der den Quellcode schwieriger zu lesen macht.

Halte da nix von dogmatischen Ansätzen, schliesslich kostest Dokumentation auch Zeit, und eine Methode mit viel JavaDoc zu refactoren kann soviel arbeit sein, dass man sie lieber nicht refactored, dan schadet sie nur...

80 Zeichen pro Zeile stammt aus den 80er Jahren, heute sind 120 zeichen/Zeile kein Problem mehr IME.

Gut finde ich die maximale Methdoenlänge zu begrenzen

 

[darekkay]

Zero Warnings Policy

 

[Gast2]

Zero Warnings Policy

Grundsätzlich ja, ist aber bei MultiTarget Programmierung (Windows, Linux, Embedded) leider aufgrund verwendeter Libs oder bekannter Probleme nicht möglich.

Erstrebenswert in jedem Fall! (Wir supressen bekannte nicht verhinderbare Warnings mit entsprechender Doku)