Project Structure and Layout Conventions

Contents

Programming Project (C#/Java)

  1. Directory structure. Naming should be followed precisely.
    1. bin - output dir (TODO: ?? bin or build. Then nest under this specific directories for each build tool and for each output type e.g.:
      • eclipse
      • ant
      • dist - packaged distributions
    2. lib - external libs kept locally
    3. docs - documentation (note docs NOT doc, Docs, Doc etc)
      1. internal - all internal documentation e.g. design, extra docs on api, code, uml ...
      2. user_guide
    4. src
    5. test
      1. testdata
    6. examples
    7. www - web stuff (TODO: or named website ???)
    if we have src files other than java (e.g. xsl etc) then need further nesting under src and test as follows:
    1. java
    2. xsl
    3. ...
  2. Each root directory should contain a build.xml file suitable for ant or nant. This should contain a basic standardized set of targets (see coding_conventions.htm for more detail).

(N)Ant Build File Organization

  1. Target Names:
    1. Consistent.
    2. Follows standard target naming conventions
      1. clean (and sub targets thereof: e.g. clean.compiled-files)
      2. build
      3. dist
      4. prepare

Database Project

Naming

  1. LCU = lower case underscore
  2. Tables
    1. singular names
    2. primary key names of form tablename_id