Apart from adding a File Header for each file (the page-level docblock), there are additional code elements to be documented.

Standard phpDocumentor Tags

  • @access
  • @author
  • @copyright
  • @deprecated
  • @example
  • @ignore
  • @internal
  • @link
  • @see
  • @since
  • @tutorial
  • @version
  • inline {@internal}} (note: Unlike other inline tags, {@internal}} may contain other inline tags due to its purpose. To terminate an {@internal}} inline tag, you must use two ending brackets "}}")
  • inline {@inheritdoc}
  • inline {@link}

Procedural Elements

A Page-level Docblock may have any of the standard phpDocumentor Tags plus the following tags:

  • @package
  • @subpackage

The ImpressCMS page level DocBlock

include/include_once/require/require_once statements

Include statements may only have the Standard phpDocumentor Tags The ImpressCMS Include DocBlock

Define Statements

A define statement's DocBlock may have any of the standard phpDocumentor Tags plus the following tag:

  • @name

The ImpressCMS Define_DocBlock

Function Declarations

A function's DocBlock may have any of the standard phpDocumentor Tags plus the following tags:

  • @global
  • @param
  • @return
  • @staticvar
  • inline{@source}

The ImpressCMS Function DocBlock

Global Variables

A global variable's DocBlock may have any of the standard phpDocumentor Tags plus the following tag:

  • @name

In addition, the global variable's DocBlock must contain the @global tag. The ImpressCMS Global_DocBlock

Class Elements

A class's DocBlock may have any of the standard phpDocumentor Tags plus the following tags:

  • @package
  • @subpackage
  • @static

The ImpressCMS Class DocBlock

Class Variables

A class variable's DocBlock may have any of the standard phpDocumentor Tags plus the following tag:

  • @var

The ImpressCMS Class Variable DocBlock

Class Methods

A method's DocBlock may have any of the standard phpDocumentor Tags plus the following tags:

  • @global
  • @param
  • @return
  • @static
  • @staticvar
  • inline{@source}

The ImpressCMS Class Method DocBlock

Categories: Getting Started, Development, Documentation

Last modified on 2015/11/1 by Anonymous
Comments
The comments are owned by the poster. We aren't responsible for their content.