Page 1 of 1

Use phpDocumenter standard to document your code.

Posted: Thu May 05, 2011 9:51 am
by KBleivik
phpDocumentor http://www.phpdoc.org/ is the current standard auto-documentation tool for the php. The WordPress default home page follows this standard. Here

Code: Select all

<?php
/**
 * Front to the WordPress application. This file doesn't do anything, but loads
 * wp-blog-header.php which does and tells WordPress to load the theme.
 *
 * @package WordPress
 */

/**
 * Tells WordPress to load the WordPress theme and output it.
 *
 * @var bool
 */
define('WP_USE_THEMES', true);

/** Loads the WordPress Environment and Template */
require('./wp-blog-header.php');
?>


is an example the follows that standard using docblocks.