Coding Guidelines

From Achievo/ATK Wiki

Jump to: navigation, search

This page contains guidelines that are not covered by the Zend Framework standard, or where ATK uses a different convention for historical/backwards compatible reasons.

We are aware that many files in our products do not yet adhere to the above guidelines, since they've had many years of coding to different standards. We will gradually adjust those files.

Naming conventions

We follow the Zend Framework naming conventions for classes, with the following exceptions:

  • Until ATK's directory structure has been converted to match a Zend Framework directory layout (see ATK/Zend Framework integration), ATK classes use its historical 'atkClassName' convention.
  • Nodes are considered business entities and are named in common english in all-lowercase, for example:
class employee extends atkMetaNode

Comments

Header for ATK

For ATK scripts, the file header is:

/**
 * This file is part of the ATK Framework distribution.
 * Detailed copyright and licensing information can be found
 * in the doc/COPYRIGHT and doc/LICENSE files which should be
 * included in the distribution.
 *
 * @package atk
 * @subpackage ... 
 *
 * @copyright (c)2000-2010 Ivo Jansch
 * @copyright (c)2000-2010 Ibuildings.nl BV
 * @license LGPL - http://www.atk-framework.com/licensing 
 *
 * @version $Revision$
 * $Id$
 */
Personal tools
Navigation