Skip to main content
Jump to: navigation, search

Difference between revisions of "MoDisco/CodingConventions"

Line 1: Line 1:
<css>p{margin-top:0.7em;margin-bottom:0.5em;}</css>
+
<css>p{margin-top:0.7em;margin-bottom:0.5em;}</css>  
  
For code style verification, a ''checkstyle'' configuration file is directly available from the MoDisco SVN:
+
=== Eclipse JDT Warnings Level<br> ===
* https://dev.eclipse.org/svnroot/modeling/org.eclipse.gmt.modisco/plugins/trunk/org.eclipse.gmt.modisco.dev.core/checkstyle/MoDisco.checkstyle
+
  
To use this file, you first need to download the [http://eclipse-cs.sourceforge.net/ Checkstyle plug-in].
+
For code style verification, it is recommended to configure Eclipse jdt settings for errors/warning levels : all rules levels set as "ignored" should be set as "warning".<br>
  
Note that Checkstyle is not an Eclipse.org tool. However, its source code is under the EPL, and its current use has been formally IP-validated for the MoDisco project:
+
Some rules might create too many constraints in some java circumstances. The developer is allowed to disactivate the rules in specific areas :<br>
* https://dev.eclipse.org/ipzilla/show_bug.cgi?id=3615 (initial CQ for EMO validation)
+
 
* http://dev.eclipse.org/mhonarc/lists/modeling-pmc/msg01391.html (email thread for Modeling PMC validation)
+
- with projects specific errors/warning levels.<br>
Also note that Checkstyle is not intended to be distributed with MoDisco.
+
 
 +
- with @SuppressWarnings, in adding some explanation to the deviation.<br>
 +
 
 +
=== Checkstyle Usage  ===
 +
 
 +
For code style verification, a ''checkstyle'' configuration file is directly available from the MoDisco SVN:
 +
 
 +
*https://dev.eclipse.org/svnroot/modeling/org.eclipse.gmt.modisco/plugins/trunk/org.eclipse.gmt.modisco.dev.core/checkstyle/MoDisco.checkstyle
 +
 
 +
To use this file, you first need to download the [http://eclipse-cs.sourceforge.net/ Checkstyle plug-in].
 +
 
 +
Note that Checkstyle is not an Eclipse.org tool. However, its source code is under the EPL, and its current use has been formally IP-validated for the MoDisco project:  
 +
 
 +
*https://dev.eclipse.org/ipzilla/show_bug.cgi?id=3615 (initial CQ for EMO validation)  
 +
*http://dev.eclipse.org/mhonarc/lists/modeling-pmc/msg01391.html (email thread for Modeling PMC validation)
 +
 
 +
Also note that Checkstyle is not intended to be distributed with MoDisco.  
  
 
[[Category:MoDisco]]
 
[[Category:MoDisco]]

Revision as of 13:24, 10 February 2010


Eclipse JDT Warnings Level

For code style verification, it is recommended to configure Eclipse jdt settings for errors/warning levels : all rules levels set as "ignored" should be set as "warning".

Some rules might create too many constraints in some java circumstances. The developer is allowed to disactivate the rules in specific areas :

- with projects specific errors/warning levels.

- with @SuppressWarnings, in adding some explanation to the deviation.

Checkstyle Usage

For code style verification, a checkstyle configuration file is directly available from the MoDisco SVN:

To use this file, you first need to download the Checkstyle plug-in.

Note that Checkstyle is not an Eclipse.org tool. However, its source code is under the EPL, and its current use has been formally IP-validated for the MoDisco project:

Also note that Checkstyle is not intended to be distributed with MoDisco.

Back to the top