JWic developer guideline

From JWic

Developers who contribute to one of the jWic projects should follow these guidelines.

Contents 1 Documentation 1.1 Licence informations 1.2 Maintain Changelog 1.3 CVS Commit 2 Naming Conventions

Documentation

Always remember that jWic is a public library where a good documentation is mandatory. This includes a short but meaningfull documentation of each methods and types. You should also note in a controls type comment if it requires the inclusion of a javaScript library or a css file to work properly.

Each package should contain a package.html file with a short description of the content.

Licence informations

Each java file must contain the licence informations in the beginning. You may use the following template for eclipse:

/*
 * Copyright 2005-2007 jWic group (http://www.jwic.de)
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * ${package_name}.${type_name}
 * Created on ${date}
 * $$Id:$$
 */

Maintain Changelog

In each projects root directory is a changes.txt file where we maintain the history of changes. This file should always be updated before something is commited into the CVS.

CVS Commit

You should always add a comment when you commit a file to the CVS.

Naming Conventions

• Interfaces should always start with a capital I (samples: IContentProvider, IService)
• Simple controls usualy end with Control in the name (samples: ButtonControl, TabControl). We do not require this anymore in newer projects (i.e. ecolib), but for controls that go into the jWic base project we still follow this rule.