FreeNAC programming conventions
Posted September 3rd, 2007 by hector
Program file headers:
/**
* filename.php
*
* Long description for file:
* Some words about the functionality the file provides, it's dependencies and so on
*
* PHP version 5
*
* LICENSE: This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License as published
* by the Free Software Foundation.
*
* @package FreeNAC
* @author XX (FreeNAC Core Team)
* @copyright 2007 FreeNAC
* @license http://www.gnu.org/copyleft/gpl.html GNU Public License Version 2
* @version SVN: $Id$
* @link http://freenac.net
*
*/
Other coding conventions:
- use two spaces when indenting
- comment your code
- always use version control, preferable SVN
- style: do not mix styles in the same source file, follow the style of the original author
- use PHP documentor tags in headers and comments
- Printer-friendly version
- Login to post comments