Code Style

Your Rating:

Thanks for voting!

Please Wait

Results:

2

rates

Java

General Style

• Check out Standard Java coding conventions. (download the PDF, because the HTML version is very badly formatted in some places)
• Google's codestyle conventions are 99% what we do or should do.
• Also read http://dev.magnolia-cms.com/~gjoseph/on-code-readability.

Order of methods

We aim for best readability - that's we (from now on) put methods is a specific order:

• technical/config methods first (e.g. getters, setters, add-methods for collections, ...) - business methods last
• methods that logically belong together should be grouped (e.g. if there's 2 constructors they should be placed next to each other)

Imports

• We use the following order
  • static imports
  • all "other" (e.g. info.*)  it would seem the Eclipse file we currently provide is not up to date with this (in particular, it does have a "other" rule, it only has one for info.magnolia.*)
  • java, javax, org, com
• .* Imports are only allowed for static ones (checked by our checkstyle setting)
  
  • configure your IDE to use 2 as Number of static imports needed for .* (e.g. in Eclipse Preferences -> Java -> Codestyle -> Organize Imports)

Indentation

• Tab policy: spaces only
• Indentation: 4 spaces for Java-Files, 2 spaces for XML
• No maximum line width, no automated line wrap

Naming

• We preferably don't use abbreviations in classnames (only exception to that rule is MgnlSomething)
• See Naming conventions
• Enums: despite enums being constants, we make an exception: lowercase/camelCase enum members are perfectly acceptable. Two reasons:
  
  • They can be used in configuration (tree), where an ALL_CAPITAL value would look out of place,
  • They can implement complex types, whereas "regular" constants are usually native types or Strings. It's not unusual to do stuff like layout.doLayout(someComponent), where layout is actually one of the values of MyLayoutEnum. It reads nicer without the capitals and underscores.

If-statements

• Single-line if-statements: we always use curly braces
• Unnecessary else-branch: if the else is not necessary (e.g. because if-branch always returns or throws an exception) we omit it

Functional-style idioms

• Streams/Optionals are formatted one operation per line, after the .stream() initiator;
  • actually can be considered a general recommendation for fluent APIs
  • static imports for Collectors is highly encouraged
• Streams are generally preferred to Guava transforms
• Optional is a good return type, not an argument type

Overrides

• for optimal refactoring support we use the @Override for all methods that override methods declared in superclasses/implemented interfaces
  
  • Hint: you might want to adapt compiler settings of your IDE to show Errors on missing @Override's (Eclipse and Idea provide that option)

SuppressWarnings

• we try to avoid using @SuppressWarnings
  
  • if it's required, make sure you use it for the smallest scope - e.g. don't add on method level when you only need it for one instruction
    • example: HttpServletRequest#getHeaderNames() returns Enumeration instead of Enumeration<String>
      • -> here you could use @SuppressWarnings("unchecked") just before lines like: Enumeration<String> myHeaderNames = myHttpServletRequest.getHeaderNames();
• we don't use @SuppressWarnings("deprecation")
  
  • using deprecated code is a smell - we wan't to be aware of places where we use old stuff
  • try to replace the deprecated code with it's replacement

serialVersionUID's

We don't explicitly set serialVersionUID's as we don't want to decide ourselves when these id's should be updated. We rely on the JVM doing that for us (being aware that this id's could potentially differ from JVM to JVM). If for any (valid) reason, such an id would be needed for a given class, the reason needs to be documented in the code. Failing that, there's a good chance the field will be removed by a fellow zealous developer.

$NON-NLS-1$

• if you come across a //$NON-NLS-1$ please just delete it - that's legacy stuff created by Eclipse - we don't want to keep that!

TODOs & FIXMEs

• these are used for minor issues or hints. As it might be handy to ask the author for details and we don't want to spend too much time on querying the SCM, it's now mandatory to add the author's name:
• e.g. TODO dlipp - tell the world we'll now always add authors to the TODOs and FIXMEs
  

class: info.magnolia.foo.MySmartDefinition
components:
  - name: First component
    class: info.magnolia.foo.MySmartComponent
    description: Some short description of the first component
  - name: Second ...