Eclipse Community Forums - RDF feed
https://www.eclipse.org/forums/
Eclipse Community ForumsCode Style - PHPDoc: @param description in same line AND a blank line before the @return-block
https://www.eclipse.org/forums/index.php/mv/msg/1085734/1760109/#msg_1760109
I have a problem with the current PDT 4.3 and can't get our requirement to PHPDoc formatting to work with it.
So in general we want to have a PHPDoc block that looks like that:
/**
* Convert request data to a common format
*
* @param $request Request The request to be handled
*
* @return array
*/
So in general we have defined a (as in my opinion a very common) code style that requires:
The description of a parameter must be in the same line as the @param-tag
There must be a blank line before the @return-tag
But with the default settings of PDT for PSR-2 I get this:
/**
* Convert request data to a common format
*
* @param $request Request
* The request to be handled
* @return array
*/
When changing some options ("new line after @param-tags") I will be able to get the parameters description in the same line as the @param-tag. But never ever I will be able to get a blank line before the @return tag.
So for me there are two questions:
Is the label of the option "new line after @param tags" correct? In my opinion the current behavior would lead to an label like "new line after params type"
How to ensure the formatter will insert/keep a blank line before the first @return-tag (as we want to use the formatter as save action)