Code style and Javadoc

Created by Imported from previous wiki, last modified by Felix Rabe on 2010-08-26

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Unknown macro: {rate}

Code style

Magnolia contributors are kindly request to follow these simple conventions below:

Standard Java coding conventions (download PDF as HTML is very badly formatted at some places)
Tab policy: spaces only
Indentation: 4 spaces
Maximum line width: 120 (no strong rule here - don't put exceptions declarations on new lines just to respect this, for instance)
We preferably don't use abbreviations in classnames (only exception to that rule is MgnlSomething)
Read http://dev.magnolia-cms.com/~gjoseph/on-code-readability

Also ensure that you have the right license headers in place !

See the file attached for Eclipse Preferences (which you can simply import and everything should be done).

[Formatting|Code style and Javadoc^eclipse-format-settings.xml]
[Code Templates|Code style and Javadoc^eclipse-codetemplates.xml]
.. or see [Checkstyle for Eclipse]. (similar instructions apply for IntelliJ)

Javadoc

Class-level documentation is mandatory.
First sentence of any Javadoc comment must finish with punctuation. (This is/was needed for summary pages/tables to include the first sentence next to the described element)
DRY.
See http://dev.magnolia-cms.com/~gjoseph/on-code-readability

No labels