MyFaces Developer Notes

This document deals with issues that are important for MyFaces developers and custom component developers.

Component developer guidelines

(same as "MyFaces developers guidelines", see below)

MyFaces developers guidelines

Code style

See http://www.apache.org/dev/styleguide.html for the Apache-Wide Coding Style Guide. Everything that is not documented there should be written according to Suns Java Code Conventions at http://java.sun.com/docs/codeconv/html/CodeConvTOC.doc.html

Error and exception handling

Whenever an exception is caught, the following applies:

Logging

Except in the JSF API (javax.faces.*) classes, where there must not be any dependencies to additional libraries, commons-logging is used for logging generally. Commons-logging should be used in the recommended way, i.e. each class has it's own private static logger.

Naming

Naming is a fundamental concern. The name of a class, method or field should tell as much as possible of it's meaning and usage. Avoid short names like "Helper", "calc" or "check". Use "FinancialConsultance", "calculateMyYearlyIncome" and "isMyIncomeTooLow" instead.

Special comments

Addition special comments (see 10.5.4 in CodeConv)

Version Control

Communication

Every file should start with the following copyright notice:

/**
 * Copyright 2004 The Apache Software Foundation.
 *
 * 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.
 */

* Class and Interface comment
  Every class and interface should have a javadoc similar to this:
/**
 * Very detailed description goes here... ;-)
 *
 * @author Bug Rogers (latest modification by $Author$)
 * @version $Revision$ $Date$
 */