News Feed
Sections




News Archive
Looking for more information on how to do PHP the right way? Check out PHP: The Right Way

PHPMaster.com:
Introduction to PhpDoc
January 10, 2012 @ 10:07:26

On PHPMaster.com today there's a new post from Moshe Teutsch about working with docblock comments in PHP scripts and how to use the phpDocumentor tool to generate the documentation from them.

If you've ever tried to read code written by someone other than yourself (who hasn't?), you know it can be a daunting task. [...] PhpDoc, short for PhpDocumentor, is a powerful tool that allows you to easily document your code via specially formatted comments. [...] By using PhpDoc, you can make it easy for others (and yourself) to understand your code - weeks, months, and even years after you've written it.

He introduces the concept of "docblocks" and includes several examples of how to comment things like packages, files, classes and functions/methods. Finally, he wraps up the post with an example of using the "phpdoc" command to run phpDocumentor and build the docs. In the comments, another tool is also suggested - DocBlox, a project that still parses the same docbloc syntax but does it in a much more memory efficient way (and is an actively maintained project).

0 comments voice your opinion now!
docbloc introduction phpdocumentor docblox comment phpdoc


blog comments powered by Disqus

Similar Posts

Refulz Blog: Traits in PHP 5.4 - Why we need Traits

PHPBuilder.com: Introduction to Arrays and Hashes in PHP - The ABC's of PHP Part 7

Thomas Hunter: CouchDB and PHP Web Development (Book Review)

David Coallier's Blog: PEAR now has User Notes/Comments

Benjamin Eberlei: SOAP and PHP in 2014


Community Events





Don't see your event here?
Let us know!


language list podcast opinion symfony interview tool library series laravel security framework community conference introduction release voicesoftheelephpant version composer artisanfiles

All content copyright, 2014 PHPDeveloper.org :: info@phpdeveloper.org - Powered by the Solar PHP Framework