10.02.2013 Views

PHP Programming Language - OpenLibra

PHP Programming Language - OpenLibra

PHP Programming Language - OpenLibra

SHOW MORE
SHOW LESS

Create successful ePaper yourself

Turn your PDF publications into a flip-book with our unique Google optimized e-Paper software.

<strong>PHP</strong>Doc 177<br />

The text that marks this as a DocBlock template is "/**#@+" - all 6 characters must be present. DocBlock templates<br />

are applied to all documentable elements until the ending template marker:<br />

/**#@-*/<br />

Note that all 8 characters must appear as "/**#@-*/" in order for phpDocumentor to recognize them as a template.<br />

Page Level DocBlocks<br />

A page-level DocBlock is the only DocBlock that cannot precede the element that it is documenting, as there is no<br />

way to precede a file. To solve this issue, the way phpDocumentor finds a page-level DocBlock is to parse the first<br />

DocBlock in a file as the page-level DocBlock, with certain conditions.<br />

<br />

This last example has one DocBlock, and it is the first DocBlock in a file, but it is not a Page-level DocBlock. How<br />

can phpDocumentor tell the difference between a Page-level DocBlock and any other DocBlock? Simple:<br />

Hooray! Your file is uploaded and ready to be published.

Saved successfully!

Ooh no, something went wrong!