Changes between Version 4 and Version 5 of ProgrammingGuidelines


Ignore:
Timestamp:
07/12/11 14:27:55 (8 years ago)
Author:
welberge
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • ProgrammingGuidelines

    v4 v5  
    11!^[[ElckerlycDocumentation]] 
    22[PageOutline] 
     3= Programming guidelines and toolkit selection = 
     4We ask contributors to Elckerlyc to adhere to certain programming guidelines. During the development of Elckerlyc 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. 
     5== Library overview == 
     6||Functionality||library|| 
     7||Logging||[http://www.slf4j.org/|Log4j]|| 
     8 
    39== Exception handling guidelines == 
    410 1. Use checked exceptions for exceptions that the client can take useful actions upon. Use !RunTimeException and its subclasses otherwise. 
     
    713 1. Don't ignore exceptions. 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. 
    814 
     15== Hmi Logging Setup == 
    916 
    1017[[ViewTopic()]]