02.06.2013 Views

Pro PHP and jQuery by Jason Lengstorf.pdf - Computer Science ...

Pro PHP and jQuery by Jason Lengstorf.pdf - Computer Science ...

Pro PHP and jQuery by Jason Lengstorf.pdf - Computer Science ...

SHOW MORE
SHOW LESS

You also want an ePaper? Increase the reach of your titles

YUMPU automatically turns print PDFs into web optimized ePapers that Google loves.

*/<br />

CHAPTER 3 ■ OBJECT-ORIENTED PROGRAMMING<br />

The real power of DocBlocks comes with the ability to use tags, which start with an at symbol (@)<br />

immediately followed <strong>by</strong> the tag name <strong>and</strong> the value of the tag. These allow developers to define authors<br />

of a file, the license for a class, the property or method information, <strong>and</strong> other useful information.<br />

The most common tags used follow:<br />

@author: The author of the current element (which might be a class, file, method, or any bit of code)<br />

are listed using this tag. Multiple author tags can be used in the same DocBlock if more than one<br />

author is credited. The format for the author name is John Doe .<br />

@copyright: This signifies the copyright year <strong>and</strong> name of the copyright holder for the current<br />

element. The format is 2010 Copyright Holder.<br />

@license: This links to the license for the current element. The format for the license information is<br />

http://www.example.com/path/to/license.txt License Name.<br />

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

Saved successfully!

Ooh no, something went wrong!