phpDoc Block Comments

PDT offers a preset means for adding phpDoc comments to files by providing an input line when including statements, classes, class variables, and constants to the code. Developers are prompted to immediately add a description ensuring that the added elements are documented in their context and in real-time.

 

phpDoc blocks are descriptive comments that are part of the application code. They are used to describe the PHP element in the exact location in the code where the element appears. The block consists of a short description, long description, and phpDoc tags.

 

Descriptions that are added above a code element are also automatically added to the Code Assist bank so that the next time the code element is used it is readily available from the Code Assist list.

In addition, the element's descriptions will appear in the Outline view.
 

phpDoc blocks also serve as the input for creating a PHPDoc.
See the Commenting PHP DocBlocks topic for more information.

 

 

Related Links

Related Links:

Commenting Code

Commenting PHP Code

Commenting PHP DocBlocks