sling-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Konrad Windszus <konra...@gmx.de>
Subject Code Styleguide
Date Tue, 12 Nov 2019 10:47:25 GMT
Hi,
As Angela noticed there is still no official code style guideline for Sling. Maybe we can
at least document the minimum somewhere below https://sling.apache.org/documentation/development.html
<https://sling.apache.org/documentation/development.html> and provide an Eclipse Formatter
Ruleset.
Such a formatter can not only be applied by Eclipse, but also by IntelliJ (https://blog.jetbrains.com/idea/2014/01/intellij-idea-13-importing-code-formatter-settings-from-eclipse/
<https://blog.jetbrains.com/idea/2014/01/intellij-idea-13-importing-code-formatter-settings-from-eclipse/>)
and we could even think about optionally applying it with maven (https://code.revelc.net/formatter-maven-plugin
<https://code.revelc.net/formatter-maven-plugin>).

Also I would recommend to also reference https://google.github.io/styleguide/javaguide.html
<https://google.github.io/styleguide/javaguide.html> as the Oracle coding conventions
are no longer maintained (https://www.oracle.com/technetwork/java/codeconventions-150003.pdf
<https://www.oracle.com/technetwork/java/codeconventions-150003.pdf>).
WDYT?

Konrad



Mime
  • Unnamed multipart/alternative (inline, None, 0 bytes)
View raw message