Can Eclipse PDT automatically add PHPDoc Blocks to code where needed?

18,715

Solution 1

place your text cursor right above your function, class or whatever, type /** and press enter and you'll have a beginning of PHPDoc written. Eg.

/**
 * 
 * Enter description here ...
 * @param unknown_type $book
 * @param unknown_type $product
 */

You can then write @ inside the comments, and use @ followed by ctrl+space to get auto-completion hints for PHPDoc tags.

Solution 2

In PDT 1.3:

Window > Preferences > PHP > Editor > Typing > Automatically close > Phpdoc and comment regions (Check) > Add Phpdoc tags (check)

Also, modify your templates to include more Phpdoc: Preferences > PHP > Templates

Share:
18,715
Kenzal Hunter
Author by

Kenzal Hunter

Senior PHP Developer and hobby blacksmith.

Updated on June 18, 2022

Comments

  • Kenzal Hunter
    Kenzal Hunter almost 2 years

    I know most of the java development tools for Eclipse will have a short-cut script for adding in JavaDoc blocks for needed elements (including the page-level).

    Further, I know that PDT will allow you to "Generate Element Comment" for many things through the Source menu.

    Is there an Eclipse plug-in out there (or perhaps it exists standard in PDT and I've just missed it) that will allow you to add PHPDoc Blocks for all/some of the supported elements in a given file?