Coding Standards

Overall, WP MVC Base implements the WordPress Coding Standards.

In addition, the project requires all functions, classes, methods, and properties to have a phpDoc style DocBlock. Examples follow, or you can simply browse the existing codebase for examples using additional tags:

Functions and methods:

/**
 * Short function description
 *
 * Longer description if necessary
 *
 * @param   type name description
 * @return  type name description
 * @access  public|protected|private
 * @abstract ( if abstract method )
 * @since   WPMVCBase version number
 */

Classes:

/**
 * Short class description
 * 
 * Longer description if necessary
 *
 * @abstract ( if abstract class )
 * @since WPMVCBase version number
 */

Properties:

/**
 * Short property description
 * 
 * Longer description if necessary
 *
 * @var    type
 * @access public|protected|private
 * @since  WPMVCBase version number
 */

For any lines not used ( e.g. long function description, simply omit the entire line ).

Other tags can be added as necessary. For a complete listing of supported tags, see the phpDocumentor2 tag reference.