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:
Generate Documentation with ApiGen
August 02, 2012 @ 09:44:43

On PHPMaster.com today there's a new tutorial showing you how to generate API documentation with the help of the ApiGen documentation tool and some commenting in your code.

If you're writing undocumented code, you should stop this very moment. I'm serious. Drop everything, save and quit, and focus on improving this essential part of your workflow. [...] ApiGen is a docblock parser like PhpDocumentor. PhpDocumentor has been around for much longer than ApiGen, but unfortunately its development is somewhat stunted and it lacks in terms of modern documentation and examples.

He shares an example class, fully commented to show off the right way to handle the DocBlocks and goes through each of the "@" types and explains what they're for. Also included are the instructions for getting ApiGen installed (via the PEAR installer) and a sample command to generate the docs from the source. You can find out more about ApiGen and some of its other options on it's main site.

0 comments voice your opinion now!
api documentation tutorial apigen docblock parse tool


blog comments powered by Disqus

Similar Posts

Zoe Slattery's Blog: So phar so good

DZone.com: Using APC correctly

SitePoint PHP Blog: Best Practices REST API from Scratch Introduction

PHPMaster.com: An Introduction to Dependency Injection, Service Locators & Factories (Part 1)

Matt Stauffer: Introducing Laravel Homestead 2.0


Community Events

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


community framework xdebug series introduction release extension conference interview voicesoftheelephpant symfony2 php7 opinion version laravel example library podcast performance api

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