Difference between revisions of "ATL Coding Chart"

From Eclipsepedia

Jump to: navigation, search
(ATL Coding Chart)
 
(Code formatter)
Line 2: Line 2:
  
 
== Code formatter ==
 
== Code formatter ==
The Eclipse code formatter helps to correctly indent and format a .java file. Basically it is activated by the ctrl+shift+F command. The formatter is parametrizable, so here is the [http://dev.eclipse.org/viewcvs/index.cgi/org.eclipse.m2m/org.eclipse.m2m.atl/plugins/org.eclipse.m2m.atl/codeStyle/ATLFormatter.xml?hideattic=1&root=Modeling_Project&pathrev=HEAD ATL specific configuration].
+
The Eclipse code formatter helps to correctly indent and format a .java file. Basically it is activated by the ctrl+shift+F command. The formatter is parametrizable, so you can found the ATL specific configuration here : org.eclipse.m2m.atl/codeStyle/ATLFormatter.xml
  
 
And here is the way to apply the ATL configuration, in the eclipse preferences :
 
And here is the way to apply the ATL configuration, in the eclipse preferences :

Revision as of 08:18, 9 September 2008

This page intent to define good coding practices in order to better manage ATL source code. The use of several tools is detailed here and will provide a way for ATL commiters and contributors to correctly contribute to the ATL project.

Code formatter

The Eclipse code formatter helps to correctly indent and format a .java file. Basically it is activated by the ctrl+shift+F command. The formatter is parametrizable, so you can found the ATL specific configuration here : org.eclipse.m2m.atl/codeStyle/ATLFormatter.xml

And here is the way to apply the ATL configuration, in the eclipse preferences : ATL format config.PNG

Code templates

The Eclipse code templates helps the developper to automatically write code parts. In order to keep this in coherence with the code formatter, here is the ATL specific configuration.

And here is the way to apply the ATL configuration, in the eclipse preferences : ATL template config.PNG

Checkstyle

Checkstyle is a well known code analyser which detects all kind of problems in a Java code. It is activated on the moste relevant ATL plugins, with a specific configuration.