added suggestions for code style

brandstaetter · brandstaetter · commit 250608a561f8 · 2013-04-06T11:28:27.000+02:00
changed indentation to 4 spaces for java and added hint how to configure XML formatting

Signed-off-by: brandstaetter &lt;hannes.mueller@gmail.com&gt;
diff --git a/development/eclipse/biojava-checkstyle.xml b/development/eclipse/biojava-checkstyle.xml
@@ -82,8 +82,5 @@ Checkstyle configuration that checks the biojava coding conventions.
   <module name="NewlineAtEndOfFile"/>
   <module name="Translation"/>
   <module name="FileLength"/>
-  <module name="FileTabCharacter">
-    <property name="severity" value="ignore"/>
-    <metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
-  </module>
+  <module name="FileTabCharacter"/>
 </module>
diff --git a/development/eclipse/biojava-formatter.xml b/development/eclipse/biojava-formatter.xml
@@ -89,7 +89,7 @@
 <setting id="org.eclipse.jdt.core.formatter.alignment_for_superclass_in_type_declaration" value="16"/>
 <setting id="org.eclipse.jdt.core.formatter.alignment_for_assignment" value="0"/>
 <setting id="org.eclipse.jdt.core.compiler.problem.assertIdentifier" value="error"/>
-<setting id="org.eclipse.jdt.core.formatter.tabulation.char" value="tab"/>
+<setting id="org.eclipse.jdt.core.formatter.tabulation.char" value="space"/>
 <setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_constructor_declaration_parameters" value="insert"/>
 <setting id="org.eclipse.jdt.core.formatter.insert_space_after_semicolon_in_try_resources" value="insert"/>
 <setting id="org.eclipse.jdt.core.formatter.insert_space_before_prefix_operator" value="do not insert"/>
diff --git a/development/hints.md b/development/hints.md
@@ -19,6 +19,11 @@ Set up your development environment (assuming the use of Eclipse) as follows:
 	* Add missing '@Deprecated' annotations
 	* Remove unnecessary casts
 	* Remove unnecessary '$NON-NLS$' tags
-	* Remove trailing white spaces on all lines 
+	* Remove trailing white spaces on all lines
+* configure XML formatting in `Preferences > XML > XML Files > Editor` 
+	* Line width: `120`
+	* Format comments (and join lines)
+	* Insert whitespace before closing empty end-tags
+	* Indent using `2` spaces
 * install the Checkstyle Plugin and import `biojava-checkstyle.xml`
 * (install the Findbugs Plugin)
