Refactor: apply best practices and coding guidelines globally #2209
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nlamarti
pushed a commit
to nlamarti/openems
that referenced
this pull request
Aug 4, 2023
…S#2209) The PR contains strictly **NO LOGIC CHANGES**, but applies best practices and coding guidelines (https://openems.github.io/openems.io/openems/latest/contribute/coding-guidelines.html) globally in OpenEMS Edge/Backend, e.g. - Use separate Interface and Implementation files for OpenEMS Edge Components - Move ChannelIds to Interfaces ("Natures" - https://openems.github.io/openems.io/openems/latest/coreconcepts.html#_nature) - Rename Component files equal to Factory-ID (makes Ctrl+R in Eclipse IDE much more convenient to use) - Reduce variable scope; use `private` wherever possible (e.g. for the `activate()`-method). This is enforced by adding and applying Checkstyle `VisibilityModifierCheck` (see https://checkstyle.sourceforge.io/apidocs/com/puppycrawl/tools/checkstyle/checks/design/VisibilityModifierCheck.html) - Sort variables in code (from `public static final` to `private`; @reference to constructor to @activate, @Modifed, @deactivate) - Use short JavaDoc for single-line comments - Use `@EventTopics` - Always implement @deactivate - Remove `package-info.java` if not necessary (i.e. reduce package scope) - Add (at least simple) JUnit tests - Update BND Bundle templates
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR applies best practices and coding guidelines (https://openems.github.io/openems.io/openems/latest/contribute/coding-guidelines.html) globally in Java, e.g.
privatewherever possible (e.g. for theactivate()-method)public static finaltoprivate; @reference to constructor to @activate, @Modifed, @deactivate)@EventTopicspackage-info.javaif not necessary (i.e. reduce package scope)The PR contains strictly NO LOGIC CHANGES.