best_practice.txt

License (copy & paste in the top of all framework files):

/**
 * Aomebo - a module-based MVC framework for PHP 5.3 and higher
 *
 * Copyright 2010 - 2015 by Christian Johansson <christian@cvj.se>
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>
 *
 * @license LGPL version 3
 * @see http://www.aomebo.org/ or https://github.com/cjohansson/Aomebo-Framework
 */

Aomebo framework is using phpDocumentor 2+ for documentation,
see 'http://www.phpdoc.org/docs/latest/index.html' for reference

Aomebo framework is using phpUnit 3.7+ for automated tests,
see 'http://www.phpunit.de/' for reference. All tests are placed
in 'Test' folder with mirrored structure.

Aomebo framework is debugged easily with Xdebug,
see 'http://xdebug.org' for reference.

Aomebo framework is using 'yEd' for managing flowcharts,
see 'http://www.yworks.com/' for reference.

Sort methods by scope, from public to private desc.
All protected and private variables and functions should be prefixed with a '_' character.

phpDoc items in the correct order:

/**
 * Comments summary (optional)
 * Comments full description (optional)
 *
 * @internal
 * @static
 * @var
 * @param
 * @return
 * @throws
 * @see
 * @deprecated
 */

@internal is only to be used with private variables and functions.
@static is only to be used with static variables and functions.