Changes between Version 60 and Version 61 of ProgrammingGuidelines


Ignore:
Timestamp:
12/04/12 17:39:34 (7 years ago)
Author:
welberge
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • ProgrammingGuidelines

    v60 v61  
    33[[PageOutline]] 
    44= Programming guidelines and toolkit selection = 
    5 We ask contributors to Asap to adhere to certain programming guidelines. During the development of Asap we have selected certain 'standard' libraries for specific tasks (for e.g. logging, unit testing, collections). Contributions to Elckerlyc should preferable not introduce dependencies on new libraries that provide very similar functionality as these libraries. 
     5We ask contributors to Asap to adhere to certain programming guidelines. During the development of Asap we have selected certain 'standard' libraries for specific tasks (for e.g. logging, unit testing, collections). Contributions to Asap should preferable not introduce dependencies on new libraries that provide very similar functionality as these libraries. 
    66== Library overview == 
    77||=Functionality=||=library=|| 
     
    1919 * Use @Override when overriding a function of a super class 
    2020 * Use the standard Java naming-scheme for classes, methods and variables 
    21 We make use of [[http://checkstyle.sourceforge.net/|checkstyle]] to check programming style. HMI specific checkstyle configurations can be found in the `HmiShared/ant/checkstyle` directory; a light-weight version of the required programming style is found in `HmiShared/ant/checkstyle/hmi-verylite.xml`. If you use Hmi's build system, you can check the style of your project using: 
     21We make use of [[http://checkstyle.sourceforge.net/|checkstyle]] to check programming style. Asap specific checkstyle configurations can be found in the `HmiShared/ant/checkstyle` directory; a light-weight version of the required programming style is found in `HmiShared/ant/checkstyle/hmi-verylite.xml`. If you use Asap's build system, you can check the style of your project using: 
    2222{{{ 
    2323ant checkstyle 
     
    3131 1. Don't ignore exceptions ([[BibCite(bloch2008)]], item 65). Either catch them and act upon them or throw them. If an exception can't happen, but has to be caught anyways, throw an !AssertionError. If the occurrence of an exception doesn't influence the progress of the client (for example, a file not properly closing after reading all information from it), at least log it. 
    3232 
    33 == Hmi Logging Setup == 
    34 All logging within HMI code is done through the [[http://www.slf4j.org/|Simple Logging Facade for Java]].  
     33== Asap Logging Setup == 
     34All logging within Asap code is done through the [[http://www.slf4j.org/|Simple Logging Facade for Java]].  
    3535This facade requires the slf4j-api.jar in the classpath. The output of SLF4J can be redirected to the logger of the clients 
    36 choice, by adding the appropriate jars in the classpath. To allow this, the Hmi 
     36choice, by adding the appropriate jars in the classpath. To allow this, the Asap 
    3737framework code itself should not put any of these logging jars in its classpath. 
    3838For the !EnvironmentDemos, [[http://logback.qos.ch/|logback]] (from the