In this chapter, we will take a look at documentation. Since this is a book for the professional PHP developer, we will primarily be dealing with code-level documentation targeted at other developers.
We will learn to create code-level documentation using phpDocumentor, PHP's entry into the xDoc family of documentation tools and the de facto standard for documenting PHP code. Specifically, we will install phpDocumentor. Next, we will learn the general syntax for DocBlocks and how to run phpDocumentor to generate the documentation. Finally, we will cover all phpDocumentor tags in some detail and look at some examples.
Note
Before we proceed further, I have to start off with a confession. The code samples and listing in the rest of this book don't fully reflect the extent of code-level documentation I would expect a reader of this book to produce. Although I have tried to make sure that there are plenty of inline comments to guide the reader, I haven...