Revision as of 23:47, 10 March 2008

Look of the code

All submitted files have to be formated eclipse style (Hit the autoformat Shift-Ctrl-F in eclipse)
Run Check Style on the file (use 'Sun Checks (Eclipse)' as check configuration) and eliminate ALL documentation warnings
ALL beanproperties and methods MUST be documented.

No System.out.println should go into SVN if it is not vital to the application. Use Log4J.

All calls to syncExec and asyncExec have to be discussed with the team and should only be used if there is absolutely no way avoiding them
Synchronizing UI and Model should occur via eclipse databinding and not through direct calls to the viewers

@@ Line 5: / Line 5: @@
 =Rules for the code=
-*No System.out.println should go into SVN if it is not vital to the application (Use commons logging from apache). To use the apache logger, make sure that your project has a dependency on org.rifidi.depenedencies.  At the top of any class that you wish to use a logger for, place a statement like this, where <tt>ClassName</tt> is the name of the class:
+*No System.out.println should go into SVN if it is not vital to the application.  Use [[Log4J]].
-<pre>
-    	private static Log logger = LogFactory.getLog(ClassName.class);
-</pre>
-To use the logger to print out something:
-<pre>
-    logger.debug("Message Here");
-</pre>
-The output will look like this:
-<pre>
-    DEBUG [THREAD_NAME] (ClassName.java:139) - Message Here
-</pre>
-Notice that this allows us to know the class name and line number that the message was printed on.  This way we can identify where in the code out output is coming from, which helps to prevent "loose" System.out.print calls.
 *All calls to syncExec and asyncExec have to be discussed with the team and should only be used if there is absolutely no way avoiding them
 *Synchronizing UI and Model should occur via eclipse databinding and not through direct calls to the viewers