PHP Objects, Patterns and Practice (3rd edition)

(Barry) #1
CHAPTER 16 ■ GENERATING DOCUMENTATION WITH PHPDOCUMENTOR

Figure 16–8. Documentation including @link and @uses tags


Summary


In this chapter, I covered the core features of phpDocumentor. You encountered the DocBlock
comment syntax and the tags that can be used with it. I looked at approaches to documenting classes,
properties, and methods, and you were provided with enough material to transform your
documentation, and thus improve collaborative working immeasurably (especially when used in
conjunction with build tools and version control). There is a lot more to this application than I have
space to cover, though, so be sure to check the phpDocumentor homepage at http://www.phpdoc.org.

Free download pdf