| // ======================================================================== |
| // Copyright (c) 1995-2017 Mort Bay Consulting Pty. Ltd. |
| // ======================================================================== |
| // All rights reserved. This program and the accompanying materials |
| // are made available under the terms of the Eclipse Public License v1.0 |
| // and Apache License v2.0 which accompanies this distribution. |
| // |
| // The Eclipse Public License is available at |
| // http://www.eclipse.org/legal/epl-v10.html |
| // |
| // The Apache License v2.0 is available at |
| // http://www.opensource.org/licenses/apache2.0.php |
| // |
| // You may elect to redistribute this code under either of these licenses. |
| // ======================================================================== |
| |
| [[coding-standards]] |
| === Coding Standards |
| |
| Jetty uses number of conventions for its source code. |
| |
| ==== Code Formatting |
| |
| Jetty uses the code formatting the following project specifies. |
| |
| http://git.eclipse.org/c/jetty/org.eclipse.jetty.admin.git/tree/jetty-eclipse-java-format.xml[Eclipse Java Formatting] |
| |
| ==== Code Templates |
| |
| Jetty specifies the following code templates for use by the project developers. |
| |
| http://git.eclipse.org/c/jetty/org.eclipse.jetty.admin.git/tree/jetty-eclipse-codetemplates.xml[Eclipse Code Templates] |
| |
| ==== Code Conventions |
| |
| The following is an example of the Java formatting and naming styles to apply to Jetty: |
| |
| [source, java, subs="{sub-order}"] |
| ---- |
| |
| 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) |
| { |
| _privateField=privateField; |
| } |
| |
| public Object getPrivateField() |
| { |
| return _privateField; |
| } |
| |
| public void doSomething() |
| throws SomeException |
| { |
| Object local_variable = _privateField; |
| if (local_variable==null) |
| { |
| // do Something |
| } |
| } |
| } |
| |
| |
| ---- |