Skip to content

Commit 0b11b10

Browse files
brandstaetterbrandstaetter
committed
added suggestions for code style
Added some code style suggestions and a short document detailing the setup on eclipse Signed-off-by: Hannes Brandstätter-Müller <hannes.mueller@gmail.com>
1 parent d0f553d commit 0b11b10

File tree

5 files changed

+563
-0
lines changed

5 files changed

+563
-0
lines changed

‎development/eclipse/biojava-checkstyle.xml‎

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!DOCTYPE module PUBLIC "-//Puppy Crawl//DTD Check Configuration 1.3//EN" "http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
3+
4+
<!--
5+
This configuration file was written by the eclipse-cs plugin configuration editor
6+
-->
7+
<!--
8+
Checkstyle-Configuration: biojava
9+
Description:
10+
Checkstyle configuration that checks the biojava coding conventions.
11+
-->
12+
<module name="Checker">
13+
<property name="severity" value="warning"/>
14+
<module name="TreeWalker">
15+
<module name="JavadocMethod">
16+
<property name="suppressLoadErrors" value="true"/>
17+
</module>
18+
<module name="JavadocType"/>
19+
<module name="JavadocVariable"/>
20+
<module name="JavadocStyle"/>
21+
<module name="ConstantName"/>
22+
<module name="LocalFinalVariableName"/>
23+
<module name="LocalVariableName"/>
24+
<module name="MemberName"/>
25+
<module name="MethodName"/>
26+
<module name="PackageName"/>
27+
<module name="ParameterName"/>
28+
<module name="StaticVariableName"/>
29+
<module name="TypeName"/>
30+
<module name="AvoidStarImport"/>
31+
<module name="IllegalImport"/>
32+
<module name="RedundantImport"/>
33+
<module name="UnusedImports"/>
34+
<module name="MethodLength"/>
35+
<module name="ParameterNumber"/>
36+
<module name="LineLength">
37+
<property name="max" value="120"/>
38+
<property name="tabWidth" value="4"/>
39+
</module>
40+
<module name="EmptyForIteratorPad"/>
41+
<module name="MethodParamPad"/>
42+
<module name="NoWhitespaceAfter"/>
43+
<module name="NoWhitespaceBefore"/>
44+
<module name="OperatorWrap"/>
45+
<module name="ParenPad"/>
46+
<module name="TypecastParenPad"/>
47+
<module name="WhitespaceAfter"/>
48+
<module name="WhitespaceAround"/>
49+
<module name="ModifierOrder"/>
50+
<module name="RedundantModifier"/>
51+
<module name="AvoidNestedBlocks"/>
52+
<module name="EmptyBlock"/>
53+
<module name="LeftCurly"/>
54+
<module name="NeedBraces"/>
55+
<module name="RightCurly"/>
56+
<module name="AvoidInlineConditionals"/>
57+
<module name="EmptyStatement"/>
58+
<module name="EqualsHashCode"/>
59+
<module name="HiddenField"/>
60+
<module name="IllegalInstantiation"/>
61+
<module name="InnerAssignment"/>
62+
<module name="MagicNumber"/>
63+
<module name="MissingSwitchDefault"/>
64+
<module name="RedundantThrows">
65+
<property name="suppressLoadErrors" value="true"/>
66+
</module>
67+
<module name="SimplifyBooleanExpression"/>
68+
<module name="SimplifyBooleanReturn"/>
69+
<module name="DesignForExtension"/>
70+
<module name="FinalClass"/>
71+
<module name="HideUtilityClassConstructor"/>
72+
<module name="InterfaceIsType"/>
73+
<module name="VisibilityModifier"/>
74+
<module name="ArrayTypeStyle"/>
75+
<module name="FinalParameters"/>
76+
<module name="TodoComment"/>
77+
<module name="UpperEll"/>
78+
<module name="OperatorWrap"/>
79+
<module name="OperatorWrap"/>
80+
</module>
81+
<module name="JavadocPackage"/>
82+
<module name="NewlineAtEndOfFile"/>
83+
<module name="Translation"/>
84+
<module name="FileLength"/>
85+
<module name="FileTabCharacter"/>
86+
</module>

‎development/eclipse/biojava-cleanup.xml‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
2+
<profiles version="2">
3+
<profile kind="CleanUpProfile" name="biojava" version="2">
4+
<setting id="cleanup.remove_unused_private_fields" value="true"/>
5+
<setting id="cleanup.always_use_parentheses_in_expressions" value="false"/>
6+
<setting id="cleanup.never_use_blocks" value="false"/>
7+
<setting id="cleanup.add_missing_deprecated_annotations" value="true"/>
8+
<setting id="cleanup.remove_unused_private_methods" value="true"/>
9+
<setting id="cleanup.convert_to_enhanced_for_loop" value="false"/>
10+
<setting id="cleanup.remove_unnecessary_nls_tags" value="true"/>
11+
<setting id="cleanup.sort_members" value="false"/>
12+
<setting id="cleanup.remove_unused_local_variables" value="false"/>
13+
<setting id="cleanup.remove_unused_private_members" value="false"/>
14+
<setting id="cleanup.never_use_parentheses_in_expressions" value="true"/>
15+
<setting id="cleanup.remove_unnecessary_casts" value="true"/>
16+
<setting id="cleanup.make_parameters_final" value="true"/>
17+
<setting id="cleanup.use_this_for_non_static_field_access" value="true"/>
18+
<setting id="cleanup.use_blocks" value="true"/>
19+
<setting id="cleanup.remove_private_constructors" value="true"/>
20+
<setting id="cleanup.always_use_this_for_non_static_method_access" value="false"/>
21+
<setting id="cleanup.remove_trailing_whitespaces_all" value="true"/>
22+
<setting id="cleanup.always_use_this_for_non_static_field_access" value="false"/>
23+
<setting id="cleanup.use_this_for_non_static_field_access_only_if_necessary" value="true"/>
24+
<setting id="cleanup.add_default_serial_version_id" value="true"/>
25+
<setting id="cleanup.make_type_abstract_if_missing_method" value="false"/>
26+
<setting id="cleanup.qualify_static_member_accesses_through_subtypes_with_declaring_class" value="true"/>
27+
<setting id="cleanup.make_variable_declarations_final" value="true"/>
28+
<setting id="cleanup.add_missing_nls_tags" value="false"/>
29+
<setting id="cleanup.format_source_code" value="true"/>
30+
<setting id="cleanup.add_missing_override_annotations" value="true"/>
31+
<setting id="cleanup.qualify_static_method_accesses_with_declaring_class" value="false"/>
32+
<setting id="cleanup.remove_unused_private_types" value="true"/>
33+
<setting id="cleanup.make_local_variable_final" value="true"/>
34+
<setting id="cleanup.add_missing_methods" value="true"/>
35+
<setting id="cleanup.add_missing_override_annotations_interface_methods" value="true"/>
36+
<setting id="cleanup.correct_indentation" value="true"/>
37+
<setting id="cleanup.remove_unused_imports" value="true"/>
38+
<setting id="cleanup.remove_trailing_whitespaces_ignore_empty" value="false"/>
39+
<setting id="cleanup.make_private_fields_final" value="true"/>
40+
<setting id="cleanup.add_generated_serial_version_id" value="false"/>
41+
<setting id="cleanup.organize_imports" value="true"/>
42+
<setting id="cleanup.sort_members_all" value="false"/>
43+
<setting id="cleanup.remove_trailing_whitespaces" value="true"/>
44+
<setting id="cleanup.use_blocks_only_for_return_and_throw" value="false"/>
45+
<setting id="cleanup.use_parentheses_in_expressions" value="false"/>
46+
<setting id="cleanup.add_missing_annotations" value="true"/>
47+
<setting id="cleanup.qualify_static_field_accesses_with_declaring_class" value="false"/>
48+
<setting id="cleanup.use_this_for_non_static_method_access_only_if_necessary" value="true"/>
49+
<setting id="cleanup.use_this_for_non_static_method_access" value="true"/>
50+
<setting id="cleanup.qualify_static_member_accesses_through_instances_with_declaring_class" value="true"/>
51+
<setting id="cleanup.add_serial_version_id" value="true"/>
52+
<setting id="cleanup.always_use_blocks" value="true"/>
53+
<setting id="cleanup.qualify_static_member_accesses_with_declaring_class" value="true"/>
54+
<setting id="cleanup.format_source_code_changes_only" value="false"/>
55+
</profile>
56+
</profiles>

0 commit comments

Comments
 (0)