Style Guide - Revision history

Matt: Reverted edits by Amesycyxa (Talk); changed back to last version by Kyle

2010-11-26T19:44:19Z

Reverted edits by Amesycyxa (Talk); changed back to last version by Kyle

2010-11-17T22:16:53Z

2008-06-04T16:00:12Z

‎Look of the code

2008-06-04T15:59:59Z

2008-04-08T16:16:26Z

‎Comments

2008-04-08T16:14:47Z

2008-03-10T23:47:40Z

‎Rules for the code

2008-02-22T20:56:57Z

‎Rules for the code

2008-02-03T21:25:42Z

‎Look of the code

2008-02-03T21:24:24Z

‎Look of the code

@@ Line 1: / Line 1: @@
->=Look of the code=
+=Look of the code=
 *We follow the naming conventions http://wiki.eclipse.org/Naming_Conventions
 *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.
 =Rules for the code=

@@ Line 1: / Line 1: @@
-=Look of the code=
+>=Look of the code=
 *We follow the naming conventions http://wiki.eclipse.org/Naming_Conventions
 *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.
 =Rules for the code=

@@ Line 1: / Line 1: @@
 =Look of the code=
-*We follow the naming conventions [http://wiki.eclipse.org/Naming_Conventions]
+*We follow the naming conventions http://wiki.eclipse.org/Naming_Conventions
 *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

@@ Line 1: / Line 1: @@
 =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

@@ Line 11: / Line 11: @@
 =Comments=
 *All methods should have method comments above them.
 *All files should have a header with the license that follows this template:

← Older revision		Revision as of 16:14, 8 April 2008
Line 9:		Line 9:
	*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		*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		*Synchronizing UI and Model should occur via eclipse databinding and not through direct calls to the viewers
		+
		+	=Comments=
		+	*All methods should have method comments above them.
		+	*All files should have a header with the license that follows this template:
		+	<pre>
		+	/*
		+	* ${file_name}
		+	*
		+	* Project: Rifidi - A developer tool for RFID
		+	* http://www.rifidi.org
		+	* http://rifidi.sourceforge.net
		+	* Copyright: Pramari LLC and the Rifidi Project
		+	* License: Lesser GNU Public License (LGPL)
		+	* http://www.opensource.org/licenses/lgpl-license.html
		+	*/
		+	</pre>
		+	To have this header generated for you automatically when you create a new file, click Windows->Preferences->Java->Code Style->Code Templates. Then Click on Comments->Files, and add the header template above. Now when you create a new file, make sure the box next to "Generate Comments" is checked.

@@ 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