Search code examples
phpeclipsephpunitphpdoceclipse-pdt

Eclipse PDT and custom PHPDoc annotations


Is there any way to add custom phpdoc annotation for Eclipse PDT? For example, I want to see @depends (for PHPUnit) in autocomplete list for comments, but now I can see there only standard annotations (for example, @deprecated) .

Thanks in advance.


Solution

  • I assumed there would be a configuration file somewhere, but looking through the various folders in my Zend Studio installation didnt give me the results I was hoping for. Searching Eclipse.org for Content Assist yielded

    So I guess the "real" way to add a new Content Assist Context would be to extend Eclipse.

    Alternative: Using Templates

    The other way to get the annotations would be to add them via Templates. Follow these steps:

    • Go to Window > Preferences > PHP > Editor > Templates.
    • Click New, fill in the dialogue and confirm everything to get back to your editor

    enter image description here

    The template is now setup to appear when in the context of a PHP Comment. Go to a UnitTest DocBlock and type @. If Content Assist does not open automatically, hit Ctrl+Space. There should be an option to select @depends now.

    enter image description here

    Confirm as you would confirm any other suggestion. This should write @depends and put your cursor right next to it (so you can insert the name of the test).