Page History

{rate}

Also see [Naming conventions].

h2. Javadoc
* Always ensure that you have the right license headers in place !
* Class-level documentation is mandatory.
** we do use @version $Id$
** we don't use @author tags any longer as we're usually not interested in the one who had create the file (SCM could tell 
you if required)
** @author can however be added as a "recognition" mark for external contributors
* @deprecated must include _since_: e.g. _@deprecated since 4.0_
* 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

{code:java}
/**
 * Sample showing how a proper Javadoc comment should look like.
 *
 * @version $Id$
 */
{code}

The $Id$ variable will be replaced by svn's keyword substitution: e.g.

{code:java}
 * @version $Id: SampleClass.java 41135 2011-01-06 18:12:01Z dlipp  $
{code}



See the file attached for Eclipse Preferences (which you can simply import and everything should be done).
* [Formatting|Coding Conventions^eclipse-format-settings.xml]
* [Code Templates|Coding Conventions^eclipse-codetemplates.xml]
.. or see [Checkstyle for Eclipse]. (similar instructions apply for IntelliJ)

_Preferences>Java>Code Style>Code Templates>Automatically add comments..._ is not used as there are different headers for the different editions.  The alternative is ... (todo)
Magnolia contributors are kindly requested to follow the simple conventions listed an the child pages. Also see [Naming conventions].

h2. Style of JUnit-Tests
With Magnolia 5 we witched to JUnit 4. As it is fully backwards compatible this does not enforce you to write your tests in the new v4-style (e.g. use @Test, @Before etc.).

We set up the following rule:
* all new test will be written in JUnit 4 style
* existing tests can/should be updated if you're touching them anyway
* existing superclasses for tests (especially in core) cannot that easily be updated as there might be lots of subclasses affected by that change. We'll lift them to v4 style in a consolidated action [(see MAGNOLIA-3655)|http://jira.magnolia-cms.com/browse/MAGNOLIA-3655]

h2. 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.