Code Conventions

Below is a list of coding conventions that are specific to jIvalo, everything else not specificially mentioned here should follow the official Sun Java Code Conventions .

Eclipce code convension configuration file can be download here EclipseJavaCodeConventions.xml .

1. Brackets should begin and end on a new line.

   Array initializers can be in a same line.

2. Indent 4 spaces.

   NO tabs. Period.

3. Javadoc MUST exist on all your methods.
4. The Apache Software License MUST be placed at the top of each and every file.

   /*
    * Copyright 2007 Markku Saarela
    * 
    * Licensed under the Apache License, Version 2.0 (the "License");
    * you may not use this file except in compliance with the License.
    * You may obtain a copy of the License at 
    *
    * http://www.apache.org/licenses/LICENSE-2.0
    *
    * Unless required by applicable law or agreed to in writing, 
    * software distributed under the License is distributed on an "AS IS" BASIS,
    * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
    * either express or implied. 
    * See the License for the specific language governing permissions and limitations under the License. 
    */
   

5. If you contribute to a file (code or documentation), add yourself to the top of the file.

   Preferred JavaDoc format is:

   @author <a href="mailto:user@domain.com">John Doe</a>