Status of PSR-5 & Suggestion

[Clint Priest]

What is the status of PSR-5, I know its in Draft "Status," but is it being actively worked on or is it dead?

How does it relate to the phpdoc.org site?  

Suggestion:

@type or @alias - Would be used to group alternatives together into a shortened name:

Currently Required:

/**

 * @var mySuppressionListStrategy|myDeliveryListStrategy $objStrategy

 */

Is quite verbose, I would propose

Alternative using @type

/** 

 * @type myListStrategies  mySuppressionListStrategy|myDeliveryListStrategy

 */

/**

 * @var myListStrategies $objStrategy

 */

Thanks,

-Clint

[Alexander Makarov]

Current text is done by phpdoc author. It was put on hold but there is a plan to form a working group to develop it further.

What's the context of your proposal? Where do you suggest to place @type annotations?

[Panlatent]

Hi, I think that if we want to implement @type, it should be able to appear anywhere, and can inherit by structure.

I'm building a PHPDoc parser based on lexical analysis, but I'm getting into some trouble

在 2017年4月2日星期日 UTC+8上午1:49:08，Alexander Makarov写道：

[Rivera, John]

Hello again —

I am watching PSR-5 because I believe it is one of the more surprising ‘non-complete’ PSRs. Documentation is essential, and a standardized documentation scheme even more so. I look forward to the revival and progress of work on PSR-5!

More pertinently, regarding the @type annotation, I must say I disagree. The documentation should be completely self-contained (with the exception of references, such as inherit or link, which makes sense in their contexts). @type as described only adds overhead — we are working hard to find the correct abstraction for our code, and now you want us to figure out the correction abstraction for our documentation?!

Just my two cents. There is, of course, the option of NOT using it at all. But having it there in the first place means someone will use it, and we will curse that person someday. :)

John

-- 
You received this message because you are subscribed to the Google Groups "PHP Framework Interoperability Group" group.
To unsubscribe from this group and stop receiving emails from it, send an email to php-fig+u...@googlegroups.com.
To post to this group, send email to php...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/php-fig/c69417fc-7e68-476f-a253-dcea9b3a8490%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.