Overview
Complete setup instructions for an Eclipse installation designed to work with this project. Includes version info, desired plugins, formatter configuration and more.
Details
- Download and install the latest Eclipse IDE for Java EE Developers
- Eclipse Plugins
- Jautodoc (find in Help → Eclipse marketplace)
- SpotBugs (find in Help → Eclipse marketplace)
- Checkstyle (find in Help → Eclipse marketplace)
...
Download all configuration files below as developerResources.zip (NOTE the Jautodoc file may have an outdated file header, so check and fix and upload the file if that is the case)
Resource | Notes | Instructions | ||
---|---|---|---|---|
Checkstyle configuration | Code style rules | Install plugin for Eclipse (via Marketplace). (OPTIONAL) | ||
Checkstyle suppressions | Code style rules | This is really for the gradle integration, see the "checkstyle" section of build.gradle for any of the projects. No explicit action needed (OPTIONAL) | ||
Configuration for JAutoDoc plugin. | Install the "JAutoDoc" plugin for Eclipse (via Marketplace). Windows → Preferences → Java → JAutoDoc (use the "Import All" button on the bottom of the screen) Also fix Java->CodeStyle -> Code Templates -> Comments -> "Overriding Methods" to look like this:
| |||
Line Termination, Charset | Configure these general settings | General → Workspace.
| ||
Java clean up config | Eclipse "clean up" configuration for Java. | Windows → Preferences → Java → Code style → Clean Up (Use the "import" button) | ||
Java formatter or the RT2 Formatter | Eclipse formatting configuration for Java. | Windows → Preferences → Java → Code style → Formatter (Use the "import" button) https://github.com/google/google-java-format https://github.com/google/google-java-format/releases/download/v1.19.2/google-java-format-eclipse-plugin-1.19.2.jar → eclipse "dropins/" folder, restart and chooose a Java→Code Style->Formatter→Formatter Implementation | ||
Javascript formatter | Eclipse formatting configuration for Javascript. | Windows → Preferences → Javascript → Code style → Formatter (Use the "import" button) | ||
HTML formatter | ||||
Java Warnings | Java Warnings in Eclipse | Click on the link and follow instructions | ||
SpotBugs excludeFilter | Configuration for SpotBugs plugin - Static code analysis configuration | Install plugin for Eclipse (via Marketplace). Windows → Preferences → Java → SpotBugs → Filter Files → Exclude Filter Files (use the "Add" button) This is really for the gradle integration, see the "findbugs" section of build.gradle for any of the projects. No explicit action needed. | ||
Javascript clean up | TBD | |||
Format On Save | Under Preferences, choose Java --> Editor --> Save Actions Ideally all of the actions in "cleanup" would be included here in save actions as well. | Check "organize imports" and "format entire file". For example: | ||
Change Font Sizes | Under Preferences, choose General --> Appearance --> Colors and Fonts |
|
...