Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "Triquetrum/Coding Style"
(Formatter and Cleanup styles) |
(We can use // @formatter:off ... // @formatter:on to disable and enable formatting, provided that the formatter is configured with on/off tags enabled.) |
||
(2 intermediate revisions by the same user not shown) | |||
Line 5: | Line 5: | ||
CamelCase variable and method names are preferred over underscores. | CamelCase variable and method names are preferred over underscores. | ||
+ | |||
+ | === Disabling Formatting === | ||
+ | See http://stackoverflow.com/questions/1024886/making-eclipses-java-code-formatter-ignore-comments for how to use | ||
+ | // @formatter:off | ||
+ | and | ||
+ | // @formatter:on | ||
+ | |||
+ | To disable and reenable formatting for block comments. Note that for this to work the formatter settings have to have on/off tags enabled. The formatter settings checked in to the repository have on/off tags enabled. | ||
+ | |||
+ | == Settings == | ||
+ | As a Triquetrum workspace consists of many projects, we set up the style for the entire workspace as opposed to configuring each project. | ||
== Configuring Eclipse Formatter Preferences for Triquetrum == | == Configuring Eclipse Formatter Preferences for Triquetrum == | ||
If you intend to submit a pull request, please set your formatter preferences as follows: | If you intend to submit a pull request, please set your formatter preferences as follows: | ||
+ | # Open the Formatter preferences: Under Mac OS X, Eclipse -> Preferences -> Java -> Code Style -> Formatter | ||
+ | # Click on Import | ||
+ | # Browse to org.eclipse.triquetrum.common/triquetrumFormatterSettings.xml and import it | ||
+ | |||
+ | === Configure the Formatter Preferences By Hand === | ||
+ | If you choose not to import the settings file above, then below are the steps necessary to configure the formatter: | ||
+ | |||
# Open the Formatter preferences: Under Mac OS X, Eclipse -> Preferences -> Java -> Code Style -> Formatter | # Open the Formatter preferences: Under Mac OS X, Eclipse -> Preferences -> Java -> Code Style -> Formatter | ||
# Click on New, then enter a name like "Triquetrum Code Style Formatter". Keep the default initialization on "Eclipse [built-in]". Click OK | # Click on New, then enter a name like "Triquetrum Code Style Formatter". Keep the default initialization on "Eclipse [built-in]". Click OK | ||
Line 23: | Line 41: | ||
## Then Click on OK | ## Then Click on OK | ||
− | == Configuring Eclipse | + | == Configuring Eclipse Clean Up Preferences for Triquetrum == |
+ | |||
Cleaning the code is a good idea. If you intend to clean the code, make the following changes: | Cleaning the code is a good idea. If you intend to clean the code, make the following changes: | ||
+ | # Open the Formatter preferences: Under Mac OS X, Eclipse -> Preferences -> Java -> Code Style -> Clean Up | ||
+ | # Click on Import | ||
+ | # Browse to org.eclipse.triquetrum.common/triquetrumCleanUpSettings.xml and import it | ||
+ | |||
+ | === Configure the Clean Up Preferences By Hand === | ||
+ | If you choose not to import the settings file above, then below are the steps necessary to configure the clean up facility: | ||
+ | |||
# Open the Formatter preferences: Under Mac OS X, Eclipse -> Preferences -> Java -> Code Style -> Clean Up | # Open the Formatter preferences: Under Mac OS X, Eclipse -> Preferences -> Java -> Code Style -> Clean Up | ||
# Click on New, then enter a name like "Triquetrum Clean Up". Keep the default initialization on "Eclipse [built-in]". Click OK | # Click on New, then enter a name like "Triquetrum Clean Up". Keep the default initialization on "Eclipse [built-in]". Click OK | ||
Line 39: | Line 65: | ||
### Remove unused private members: checked | ### Remove unused private members: checked | ||
### Remove unused local variables: checked | ### Remove unused local variables: checked | ||
+ | |||
+ | == Cleaning up the code == | ||
+ | # '''Important: Before cleaning the all the Triquetrum code, consult with the team to be sure that they have no open branches.''' | ||
+ | # Check out a new branch. | ||
+ | # Set up both the cleanup and formatter preferences as above. | ||
+ | # Switch to the Java Perspective with Window -> Perspective -> Open Perspective -> Java. | ||
+ | # Select all the packages. | ||
+ | # Right click and select Source -> Cleanup. | ||
+ | # Review the changes. | ||
+ | # Accept the changes. | ||
+ | # Commit and push. | ||
== See Also == | == See Also == | ||
+ | * [https://github.com/eclipse/triquetrum/blob/master/CONTRIBUTING.md Triquetrum/CONTRIBUTING.md] - How to contribute to Triquetrum. | ||
* [[Coding Conventions]] | * [[Coding Conventions]] | ||
− | * [https://dev.eclipse.org/mhonarc/lists/incubation/msg00142.html | + | * [https://dev.eclipse.org/mhonarc/lists/incubation/msg00142.html Eclipse Incubation Mailing List discussion about coding style] |
Latest revision as of 15:54, 7 September 2016
Contents
Coding Conventions
In general, we follow the Eclipse Coding Conventions, with the following changes:
- indentations are 2 spaces, no TABs
- longer lines (160 chars)
CamelCase variable and method names are preferred over underscores.
Disabling Formatting
See http://stackoverflow.com/questions/1024886/making-eclipses-java-code-formatter-ignore-comments for how to use
// @formatter:off
and
// @formatter:on
To disable and reenable formatting for block comments. Note that for this to work the formatter settings have to have on/off tags enabled. The formatter settings checked in to the repository have on/off tags enabled.
Settings
As a Triquetrum workspace consists of many projects, we set up the style for the entire workspace as opposed to configuring each project.
Configuring Eclipse Formatter Preferences for Triquetrum
If you intend to submit a pull request, please set your formatter preferences as follows:
- Open the Formatter preferences: Under Mac OS X, Eclipse -> Preferences -> Java -> Code Style -> Formatter
- Click on Import
- Browse to org.eclipse.triquetrum.common/triquetrumFormatterSettings.xml and import it
Configure the Formatter Preferences By Hand
If you choose not to import the settings file above, then below are the steps necessary to configure the formatter:
- Open the Formatter preferences: Under Mac OS X, Eclipse -> Preferences -> Java -> Code Style -> Formatter
- Click on New, then enter a name like "Triquetrum Code Style Formatter". Keep the default initialization on "Eclipse [built-in]". Click OK
- In the Profile window make the following changes
- In the Indentation tab (Erwin is the primary developer of Triquetrum and prefers two space indents):
- Tab Policy: select "Spaces Only"
- Indentation size: 2
- Tab size: 2
- In the New Lines tab (Christopher likes to run scripts on source files, so they need newlines):
- Click on "at end of file"
- In the Line Wrapping tab (Erwin likes long lines):
- Maximum line width: 160
- In the Comments tab:
- Maximum line width for comments: 160
- Then Click on OK
- In the Indentation tab (Erwin is the primary developer of Triquetrum and prefers two space indents):
Configuring Eclipse Clean Up Preferences for Triquetrum
Cleaning the code is a good idea. If you intend to clean the code, make the following changes:
- Open the Formatter preferences: Under Mac OS X, Eclipse -> Preferences -> Java -> Code Style -> Clean Up
- Click on Import
- Browse to org.eclipse.triquetrum.common/triquetrumCleanUpSettings.xml and import it
Configure the Clean Up Preferences By Hand
If you choose not to import the settings file above, then below are the steps necessary to configure the clean up facility:
- Open the Formatter preferences: Under Mac OS X, Eclipse -> Preferences -> Java -> Code Style -> Clean Up
- Click on New, then enter a name like "Triquetrum Clean Up". Keep the default initialization on "Eclipse [built-in]". Click OK
- In the Profile window make the following changes:
- In the Code Organizing tab:
- Format source code: checked
- Remove trailing whitespace: checked
- Correct Indentation: checked
- Organize imports: checked
- Sort Members: not checked (this might change in the future)
- In the Code Style tab:
- Use blocks in if/while/for/do statements: checked (Blocks in if statements make it easier to avoid bugs that occur when a second line is added to just after the if statement)
- In Unnecessary Code tab:
- Remove unused private members: checked
- Remove unused local variables: checked
- In the Code Organizing tab:
Cleaning up the code
- Important: Before cleaning the all the Triquetrum code, consult with the team to be sure that they have no open branches.
- Check out a new branch.
- Set up both the cleanup and formatter preferences as above.
- Switch to the Java Perspective with Window -> Perspective -> Open Perspective -> Java.
- Select all the packages.
- Right click and select Source -> Cleanup.
- Review the changes.
- Accept the changes.
- Commit and push.
See Also
- Triquetrum/CONTRIBUTING.md - How to contribute to Triquetrum.
- Coding Conventions
- Eclipse Incubation Mailing List discussion about coding style