Coding Styleguide

Tabs, Line Breaks, Encoding

• Tab width is 4 characters. Don't use spaces instead of tabs.
• Line breaking style is UNIX (CR, ASCII 13)
• Text encoding is UTF-8
• Maximum line length is 132 characters

Spaces

• No space after ( [ {, no space before ) ] }, e.g.   (a)
• One space around operands, e.g.   b = ((String) obj).length() - 1
  Note: type casting is also an operator
  Exceptions:
  no space after the unary ! and - operators
  no space after the unary ++ and -- prefix-operators
  no space before the unary ++ and -- postfix-operators
• One space after comma, e.g.   f(a, b)

Empty lines

• No empty lines inside methods (consider "//" lines to separate statement groups)
• No empty lines between method head and javadoc comment
• No whitespace at end of line
• One CR at end of file, but no further whitespace
• One empty line to separate methods
• An empty line is the sequence of two CRs, no whitespace between the CRs

Statement blocks

• Use { } also if block consists of only one statement
• Place { at the end of same line

       if (done) {
           ...
       } else {
           ...
       }

• Put switch, case and default in the same column

       switch (a) {
       case 1:
           ...
           break;
       case 2:
           ...
           break;
       default:
           ...
       }

• Loops

       for (int i = 0; i < count; i++) {
           ...
       }

       while (!found) {
           ...
       }

Class Layout

• Mark the begin of a logical group of methods with a 3-line header comment // **********
  General groups are Constants, Variables, Constructors, and Inner Classes.
  In the case of a topic custom implementation standard method groups are Overriding Hooks and Custom Methods.
  
• Mark the begin of a logical subgroup of methods with a 3-line header comment // ----------
  In the case of a topic custom implementation see Hooks for standard method subgroups of the Overriding Hooks group.
  
• 3 empty lines before and after a method groups header
• 3 empty lines after import section

package de.deepamehta.topics;

import de.deepamehta.BaseTopic;
import de.deepamehta.service.ApplicationService;
...
//
import java.text.DateFormat;
import java.util.*;



/**
 * Last functional change: 17.9.2007 (2.0b8)<br>
 * Last documentation update: 6.7.2007 (2.0b8)<br>
 * Jörg Richter<br>
 * jri@freenet.de
 */
public class CalendarTopic extends LiveTopic {



    // *****************
    // *** Constants ***
    // *****************



    private static final int CALENDAR_DAY_START_HOUR = 9;
    private static final int CALENDAR_DAY_END_HOUR = 22;
    ...



    // *****************
    // *** Variables ***
    // *****************



    ...
    ...



    // *******************
    // *** Constructor ***
    // *******************



    public CalendarTopic(BaseTopic topic, ApplicationService as) {
        super(topic, as);
    }



    // ************************
    // *** Overriding Hooks ***
    // ************************



    // ------------------
    // --- Life Cycle ---
    // ------------------



    public CorporateDirectives evoke(Session session, String topicmapID, String viewmode) {
        ...
    }



    // ---------------------------
    // --- Handling Properties ---
    // ---------------------------



    public CorporateDirectives propertiesChanged(Hashtable newProps, Hashtable oldProps,
                                            String topicmapID, String viewmode, Session session) {
        ...
    }

    public Vector disabledProperties(Session session) {
        ...
    }



    // **********************
    // *** Custom Methods ***
    // **********************



    void updateView(CorporateDirectives directives) {
        ...
    }



    // *********************
    // *** Inner Classes ***
    // *********************



    private class GridCell {
        ...
    }
}