Difference between revisions of "Style Guide"
From RifidiWiki
(→Rules for the code) |
(→Look of the code) |
||
| Line 1: | Line 1: | ||
=Look of the code= | =Look of the code= | ||
| − | + | *All submitted files have to be formated eclipse style (Hit the autoformat Shift-Ctrl-F in eclipse) | |
| − | + | *Run Check Style on the file (use 'Sun Checks (Eclipse)' as check configuration) and eliminate ALL documentation warnings | |
| + | |||
=Rules for the code= | =Rules for the code= | ||
*No System.out.println should go into SVN if it is not vital to the application (Use commons logging from apache) | *No System.out.println should go into SVN if it is not vital to the application (Use commons logging from apache) | ||
*All calls to syncExec and asyncExec have to be discussed with the team and should only be used if there is absolutely no way avoiding them | *All calls to syncExec and asyncExec have to be discussed with the team and should only be used if there is absolutely no way avoiding them | ||
*Synchronizing UI and Model should occur via eclipse databinding and not through direct calls to the viewers | *Synchronizing UI and Model should occur via eclipse databinding and not through direct calls to the viewers | ||
Revision as of 21:24, 3 February 2008
Look of the code
- All submitted files have to be formated eclipse style (Hit the autoformat Shift-Ctrl-F in eclipse)
- Run Check Style on the file (use 'Sun Checks (Eclipse)' as check configuration) and eliminate ALL documentation warnings
Rules for the code
- No System.out.println should go into SVN if it is not vital to the application (Use commons logging from apache)
- All calls to syncExec and asyncExec have to be discussed with the team and should only be used if there is absolutely no way avoiding them
- Synchronizing UI and Model should occur via eclipse databinding and not through direct calls to the viewers
