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

php eclipse eclipse-plugin eclipse-pdt
Kenzal Hunter picture Kenzal Hunter · Jan 26, 2009 · Viewed 18.7k times · Source

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?

Answer

myselfhimself picture myselfhimself · Aug 20, 2010

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.

Related questions

How do you debug PHP scripts?

How do you debug PHP scripts? I am aware of basic debugging such as using the Error Reporting. The breakpoint debugging in PHPEclipse is also quite useful. What is the best (in terms of fast and easy) way to debug …

Read More
Aptana Studio vs. Eclipse

I am a beginner. I am using Aptana Studio for PHP. Today, I also downloaded Eclipse. I notice most of the features and workings are similar. It seems one is built on the code-base of the other. If so, what …

Read More
How to install Eclipse + PHP Development Tools (PDT) + Debugger on Mac in The Year 2011

I had a lot of trouble installing Eclipse and PDT on my system. It took two days, largely because all the tutorials I could find were out of date (written in 2008, it's 2011 now) and various steps they included were no …

Read More