Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "Papyrus/Code Standards"

(→‎Coding rules for Papyrus plug-ins and features)
 
(8 intermediate revisions by 2 users not shown)
Line 4: Line 4:
  
  
−
== Java classes ==
+
==Features and Plugins==
 +
We prefer when the Bundle-Name and Bundle-Vendor fields are externalized in the properties file.
 +
So we expect a file bundle.properties (or sometimes renamed into plugin.properties) for Plug-In, and a file feature.properties for Feature.
 +
A such file must be embedded in the binary build, so you must check in the ''Build Configuration'' tab that the file is selected.
  
−
*All APIs must be documented with JavaDoc comments. Automatic generation of JavaDoc comments may help, but the automatically generated comments are '''templates'''. They are not sufficient. It is better not to generate javadoc comments than to generate empty comments.
+
== Features  ==
−
*No abbreviations - the class, methods and variables should have meaningful names
+
−
*Formatting - the code should be formatted in accordance with format templates
+
−
*Always use brackets in conditions, loops, ...
+
−
*Compile - the modified code and other plugins should be compilable. Be sure to use '''Java 1.5 code compatibility'''. Check other plugins that could be influenced before commiting!
+
−
*Standard Java Rules coding - Unless specified differently, the Java Standard Coding rules should be applied: no abbreviations, variables starting with lower case; class and types with upper case; Composed name separated with upper case; no underscore in names; ...
+
  
−
*Each Java class must contain the Copyright/Licence/Contributor header. e.g.:
+
*ID:
 +
**Main Papyrus components: org.eclipse.papyrus.<feature.name>.feature
 +
***e.g. ''org.eclipse.papyrus.infra.core.feature''
 +
*Name: Papyrus <Feature Name> 
 +
**e.g. ''Papyrus Core''
 +
**e.g. ''Papyrus Model2Doc (Incubation)''
 +
***Incubation plugin and feature have a version lower than 1.0.0
 +
***Here you will find a definition of incubation: [[Development_Resources/Process_Guidelines/What_is_Incubation]]
 +
*Each feature.xml file must contains:
 +
**in ''Information Tab -> Copyright Notice'',
 +
*** ''Optional URL'' : ''https://www.eclipse.org/legal/epl-2.0/''
 +
*** ''Copyright'' :  
 +
<blockquote>
 +
Copyright (c) 20XX CEA LIST
 +
<br/>
 +
All rights reserved. This program and the accompanying materials
 +
are made available under the terms of the Eclipse Public License
 +
2.0
 +
<br/>
 +
which accompanies this distribution, and is available at
 +
https://www.eclipse.org/legal/epl-2.0/
 +
<br/>
 +
SPDX-License-Identifier: EPL-2.0
 +
</blockquote>
  
−
<source lang="java">/*****************************************************************************
+
[[Image:CopyrightNoticeFeature.png|700px|thumb|none]]
−
* Copyright (c) 2016 CEA LIST.
+
−
*
+
−
* All rights reserved. This program and the accompanying materials
+
−
* are made available under the terms of the Eclipse Public License v1.0
+
−
* which accompanies this distribution, and is available at
+
−
* http://www.eclipse.org/legal/epl-v10.html
+
−
*
+
−
* Contributors:
+
−
*  Camille Letavernier (CEA LIST) camille.letavernier@cea.fr - Initial API and implementation
+
−
*****************************************************************************/</source>
+
  
−
*You must '''not''' use the standard console output in Papyrus plug-ins. Use the [[Papyrus Developer Guide/Papyrus Log|Papyrus log]] instead
+
** in ''Information Tab -> License Agreement''
 +
***Check the field ''Shared License'',
 +
***License Feature ID: ''org.eclipse.license'',
 +
***License Feature Version: ''2.0.2''.
  
−
*In case of doubt - check existing code from those following the rules&nbsp;:-)
+
[[Image:LicenseAgreementFeature.png|700px|thumb|none]]
  
−
 
−
== Features  ==
 
−
 
−
*ID:
 
−
**Main Papyrus components: org.eclipse.papyrus.&lt;feature.name&gt;.feature
 
−
***e.g. ''org.eclipse.papyrus.infra.core.feature''
 
−
**Extra components: org.eclipse.papyrus.extra.&lt;feature.name&gt;.feature
 
−
***e.g. ''org.eclipse.papyrus.extra.marte.feature''
 
−
*Name: Papyrus &lt;Feature Name&gt; (Incubation)
 
−
**e.g. ''Papyrus core (Incubation)''
 
−
**e.g. ''Papyrus Marte (Incubation)''
 
−
*Each feature must contain the files ''epl-v10.html'' and ''license.html'' (April 9, 2014)
 
 
*The build.properties file must contain the following files in the "Binary build" section:  
 
*The build.properties file must contain the following files in the "Binary build" section:  
−
**epl-v10.html
 
 
**feature.properties (When available)  
 
**feature.properties (When available)  
 
**feature.xml  
 
**feature.xml  
−
**licence.html
 
−
*The build.properties file must contain the following files in the "Source build" section:
 
−
**build.properties (Optional)
 
−
**epl-v10.html
 
−
**licence.html
 
  
 
<br>
 
<br>
−
[[Image:Papyrus.Build.properties-selectedOptions.png]]
 
  
−
= Tests =
+
[[Image:Papyrus.Build.properties-selectedOptions.png|1000px|thumb|none]]
  
−
== Test plug-ins ==
+
<br>
−
 
+
−
Each plug-in contributed within the Papyrus project must be accompanied with a Test plug-in (And their associated Feature). Each test plug-in must ''at least'' contain a test class so that it can be included to the build/test infrastructure. Of course, the more tests it actually contains, the better...
+
  
−
The test plug-ins and features must follow the same rules as the other Papyrus plug-ins.  
+
==Additional information for the build process==
 +
The build process also needs to know where is the license. There are 2 solutions :
 +
===Option 1===
 +
In the main pom.xml file (often in the pom.xml of ''releng/folder''), you must write:
  
−
== Automatic check ==
+
<repositories>
 +
<repository>
 +
<id>license-feature</id>
 +
<url>http://download.eclipse.org/cbi/updates/license/</url>
 +
<layout>p2</layout>
 +
</repository>
 +
</repositories>
  
−
Most of these rules are checked automatically when running the Papyrus tests. If you want to check them locally, use the plug-in ''org.eclipse.papyrus.bundles.tests'' (''Run as &gt; Junit plug-in test'' or use the ''*.launch'' file from this plug-in). This plug-in can be retrieved on the Papyrus Git repository: http://git.eclipse.org/c/papyrus/org.eclipse.papyrus.git/tree/tests/junit/plugins/developer/org.eclipse.papyrus.bundles.tests
+
===Option 2===
 +
Your target platform definition file (tpd) must also contains:  
 +
location "http://download.eclipse.org/cbi/updates/license/" eclipse-license {
 +
  org.eclipse.license.feature.group lazy
 +
}
  
 
[[Category:Papyrus]]
 
[[Category:Papyrus]]

Latest revision as of 10:37, 19 November 2020

Coding rules for Papyrus plug-ins and features

These rules apply to all plug-ins and features developed for the Papyrus Eclipse project, and distributed under the EPL licence.


Features and Plugins

We prefer when the Bundle-Name and Bundle-Vendor fields are externalized in the properties file. So we expect a file bundle.properties (or sometimes renamed into plugin.properties) for Plug-In, and a file feature.properties for Feature. A such file must be embedded in the binary build, so you must check in the Build Configuration tab that the file is selected.

Features

  • ID:
    • Main Papyrus components: org.eclipse.papyrus.<feature.name>.feature
      • e.g. org.eclipse.papyrus.infra.core.feature
  • Name: Papyrus <Feature Name>
  • Each feature.xml file must contains:

Copyright (c) 20XX CEA LIST
All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0
which accompanies this distribution, and is available at https://www.eclipse.org/legal/epl-2.0/
SPDX-License-Identifier: EPL-2.0

CopyrightNoticeFeature.png
    • in Information Tab -> License Agreement
      • Check the field Shared License,
      • License Feature ID: org.eclipse.license,
      • License Feature Version: 2.0.2.
LicenseAgreementFeature.png
  • The build.properties file must contain the following files in the "Binary build" section:
    • feature.properties (When available)
    • feature.xml


Papyrus.Build.properties-selectedOptions.png


Additional information for the build process

The build process also needs to know where is the license. There are 2 solutions :

Option 1

In the main pom.xml file (often in the pom.xml of releng/folder), you must write: 

<repositories>
		<repository>
			<id>license-feature</id>
			<url>http://download.eclipse.org/cbi/updates/license/</url>
			<layout>p2</layout>
		</repository>
</repositories>

Option 2

Your target platform definition file (tpd) must also contains: 

location "http://download.eclipse.org/cbi/updates/license/" eclipse-license {
 org.eclipse.license.feature.group lazy
}
Retrieved from "https://wiki.eclipse.org/index.php?title=Papyrus/Code_Standards&oldid=441660"

This page was last modified 10:37, 19 November 2020 by vincent.lorenzo . Based on work by Pauline deville, Quentin Le Menez and Ansgar Radermacher and others.

Back to the top