Difference between revisions of "Jetty/Contributor/Coding Standards"

From Eclipsepedia

Jump to: navigation, search
Line 1: Line 1:
{{Jetty Contributor}}
{{Jetty Contributor}}
{{Jetty Redirect|http://www.eclipse.org/jetty/documentation/current/coding-standards.html}}
==Code Formatting==
==Code Formatting==

Latest revision as of 15:45, 23 April 2013

[edit] Code Formatting

Jetty uses the code formatting the following project specifies.

[edit] Code Templates

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

[edit] Code Conventions

The following is an example of the Java formatting and naming styles to apply 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