Jump to: navigation, search

Jetty/Contributor/Coding Standards

< Jetty‎ | Contributor
Revision as of 14:31, 13 April 2009 by Jesse.mcconnell.gmail.com (Talk | contribs) (New page: ==Code Formatting== Jetty uses the code formatting as specified in the following project. * http://dev.eclipse.org/svnroot/rt/org.eclipse.jetty/admin/jetty-eclipse-java-format.xml ==Cod...)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Code Formatting

Jetty uses the code formatting as specified in the following project.

Code Templates

Jetty specifies the following code templates for use by the project developers.

Code Conventions

The following is an example of the java formatting and naming styles to be applied to Jetty:

import some.exact.ClassName;      // GOOD
import some.wildcard.package.*;   // BAD!
package org.always.have.a.package;
/* --------------------------------------------------------- */
/** Always have some javadoc
class MyClassName
    // indent by 4 spaces.
    // use spaced to indent
    // The code must format OK with default tabsize of 8.
    private static final int ALL_CAPS_FOR_PUBLIC_CONSTANTS=1;
    // Field prefixed with __ for static of _ for normal fields.
    // This convention is no longer mandatory, but any given
    // class should either consistently use this style or not.
    private static String __staticField;
    private Object _privateField;
    // use getters and setters rather than public fields.
    public void setPrivateField(Object privateField)
    public Object getPrivateField()
        return _privateField;
    public void doSomething()
        throws SomeException
        Object local_variable = _privateField;
        if (local_variable==null)
             // do Something