ExDB - Developers' Corner :)

  • internal documentation related to ExDB & apps around
  • everybody can participate, topics will be discussed and subsequently agreed/realized
  • shall contain:
    • internals highlights & info
    • coding style guide

TODO

  • :?: what version of Java to use? 1.6?

Coding Style Notes

  • basic code style according to Sun's Java Code Conventions
  • the root package is swing.exdb
  • common .java file header (see example)
  • use of Java Logging API (see example)
  • JavaDoc/comments/identifiers are preferably in English
  • suggested source indentation - 1 level == 4 spaces (no tabs please)
  • line wrapping - around 100 chars per line

A Java Source File

/*
 *  ClassName.java
 *
 *  Copyright (C) 2006-2012 Software Engineering Group (SWING),
 *  Czech Technical University in Prague, FEE+FIT,
 *  Departments of Computer Science & Software Engineering
 *
 *  All rights reserved.
 *
 *
 *  Part of the ExDB project (http://exdb.fit.cvut.cz)
 *
 */
package swing.exdb.sample;

import java.util.logging.Logger;

/**
 *  Some class comment ...
 */
public class Main {
    ...

    /** The logging facility */
    private static Logger logger = Logger.getLogger(Main.class.getName());

    ...
}
ls1112_devrules.txt · Last modified: 2012/02/23 12:08 by loupalp
 
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Noncommercial-Share Alike 3.0 Unported
Recent changes RSS feed Donate Powered by PHP Valid XHTML 1.0 Valid CSS Driven by DokuWiki