PHP Objects, Patterns and Practice (3rd edition)

CHAPTER 16 ■ GENERATING DOCUMENTATION WITH PHPDOCUMENTOR

So in the following DocBlock comment, I document the CommandContext object and emphasize the
fact that it is commonly used in the Command::execute() method:

/**

• Encapsulates data for passing to, from and between Commands.


• Commands require disparate data according to context. The


• CommandContext object is passed to the Command::execute()


• method and contains data in key/value format. The class


• automatically extracts the contents of the $_REQUEST


• superglobal.


• 
  


• @package command


• @author Clarrie Grundie


• @copyright 2004 Ambridge Technologies Ltd


• @see Command::execute()
  */

class CommandContext {
// ...

As you can see in Figure 16–7, the @see tag resolves to a link. Clicking this will lead you to the
execute() method.

Figure 16–7. Creating a link with the @see tag