Consortium Activities Projects Forge Events

ASPIRE RFID Coding guidelines

1 Coding guidelines

----
#toc("" "" "")
----

1.1 Guideline summary

1.1 Namespaces
1.1.1 Trunk and branches
Sources must be prefixed by the following namespaces.

* Java : <code>org.ow2.aspirerfid</code>
* Bundles symbolic names : <code>org.ow2.aspirerfid</code>
* OSGi service.pid prefix: <code>org.ow2.aspirerfid</code>
* JMX ObjectNames for end-to-end management: <code>org.ow2.aspirerfid:type=~~component~~,name=~~concern~~</code>
* C# : <code>Org.Ow2.AspireRfid</code>
* PHP : TODO
* XML (XML Schema) : TODO
* WebServices (WSDL, ...) : TODO
* ...

1.1.1 Sandboxes

* Java : <code>org.ow2.aspirerfid.sandbox</code>
* Bundles symbolic names : <code>org.ow2.aspirerfid.sandbox</code>
* C# : <code>org.ow2.aspirerfid.sandbox</code>
* PHP : TODO
* XML (XML Schema) : TODO
* WebServices (WSDL, ...) : TODO
* ...

1.1 Sub project group and artifact ids

Names and ids must be prefixed by the following namespaces.
* Artifact/bundle names : <code>OW2 :: AspireRFID ::</code>
* Artifact ids : <code>org.ow2.aspirerfid.</code>

1.1 Files
Two mandatory files (NOTICE and LICENSE) must be provided in each project directory
* <code>NOTICE</code> contains the description of the dependencies and their licenses.
* <code>LICENSE</code> contains the license text.

Those files are automatically added in the artifact after the package phase

1.1.1 NOTICE file
{pre}
<pre>
OW2 :: AspireRFID :: Foobar Reader
Copyright 2008-2010 OW2 AspireRFID Project http://wiki.aspire.ow2.org

I. Included Software

This product includes software developed at
The OW2 Consortium (http://www.ow2.org/).
Licensed under the LGPL v2.1.

II. Used Software

This product uses software developed at
the FooBar project (http://code.foo.org/bar).
licensed under the Apache License 2.0.

This product uses software developed at
the TicTac project (http://code.tic.org/tac).
licensed under the LGPL v2.1.

III. License Summary
- LGPL v2.1
</pre>
{/pre}

1.1.1 LICENSE file

1.1 Beginning comments
All source files (Java, XML, ...) must begin with the comments shown in the following code sample.

{pre}
<pre>
/**
 * Copyright (c) 2008-2010, AspireRFID
 *
 * This library is free software; you can redistribute it and/or
 * modify it either under the terms of the GNU Lesser General Public
 * License version 2.1 as published by the Free Software Foundation
 * (the "LGPL"). If you do not alter this
 * notice, a recipient may use your version of this file under the LGPL.
 *
 * You should have received a copy of the LGPL along with this library
 * in the file COPYING-LGPL-2.1; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 *
 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY
 * OF ANY KIND, either express or implied. See the LGPL  for
 * the specific language governing rights and limitations.
 *
 * Contact: AspireRFID mailto:aspirerfid@ow2.org
 */
</pre>
{/pre}

1.1 Checkstyle

1.1 Dependencies license compatibility and tracking

[Open Source License Checker>http://sourceforge.net/projects/oslc] (oslc) is a tool for inspection and analysis of licence information from open source packages. It audits a code base and provide licenses conflicts. USE IT !

The dependencies must be listed in the NOTICE file.

1.1 References
* Java Code Conventions - Sun Microsystems, Inc. No ref. number, only hyperlink: http://java.sun.com/docs/codeconv/

* How to Write Doc Comments for JavaDoc - Sun Microsystems, Inc. http://java.sun.com/products/jdk/javadoc/writingdoccomments.html

* JavaDoc homepage - Sun Microsystems, Inc. http://java.sun.com/products/jdk/javadoc