Package org.eclnt.util.codingconventions

Class CodingConventions

java.lang.Object
org.eclnt.util.codingconventions.CodingConventions
public class CodingConventions extends Object
This class summarizes the coding conventions used inside CaptainCasa.

Section sequence inside class
1. inner classes
2. members
3. constructors
4. public methods
5. protected/private methods
Separation by using comment lines.

Brackets/Spacing:
. opening and closing bracket in own line
. 4 spaces per indent level
. no empty lines in code (e.g. in one method)
. empty lines between methods (exception: inner classes)

Naming rules

Language:
. English

Class name:
. starting with upper case character
. camel case
. noun

Method name:
. starting with lower case character
. camel case
. verb

JavaDoc comments:
. JavaDoc in English
. No trivial JavaDoc (e.g. "Sets the name" for method "setName(..)")
. Better: proper naming of method
. Minimum HTML formatting

  • Constructor Details

    • CodingConventions

      public CodingConventions(String member1, String member2)

  • Method Details

    • getMember1

      public String getMember1()

    • setMember1

      public void setMember1(String member1)

    • getMember2

      public String getMember2()

    • setMember2

      public void setMember2(String member2)

    • clearData

      public void clearData()

    • JUNIT_removeData

      public void JUNIT_removeData()