Adding PHP DocBlock Comments

 

This procedure describes how to add PHPDoc Comments to PHP elements.

 

To create a PHPDoc Comment:

In the line above the code for the PHP element, enter the DocBlock characters /** and press Enter.
-Or- Right-click the relevant element in the Outline View and select Source | Add PHPDoc.

A PHPDoc Comment will be created with several parameters to be edited with the relevant information.

The default code comments generated for diferent elements can be configured through the Code Templates Preferences page (accessed by going to Window | Preferences | PHP | Code Style | Code Templates.

 

 

Related Links

Related Links:

Commenting Code

Commenting PHP Code

phpDoc Comments