php-the-right-way icon indicating copy to clipboard operation
php-the-right-way copied to clipboard

Chapter 16 to be updated with php's typehinting and return types?

Open svdv22 opened this issue 2 years ago • 3 comments

Now that PHP supports typehinting and return types the @param, @return and also @throws documentations are obsolete. Explaining these would be outside the scope of that chapter, but personally I would not advice to still use them. Perhaps limit the chapter to just the example of @author and @link with a link to phpDocumentor. What are your thoughts?

svdv22 avatar Apr 14 '23 10:04 svdv22

I do not agree, especially with @param because you can provide a description which can be helpful in cases where the type hint alone does not provide enough information about the expected parameter value.

SandroMiguel avatar Apr 14 '23 10:04 SandroMiguel

In my experience the combination of typehint + variable name is almost always enough. If not, I could see the added value of @param with a description. Conclusion could be to change the chapter explaining that. But as the chapter stands now It feels a little outdated to me.

svdv22 avatar Apr 14 '23 14:04 svdv22

To get (more) meaningful results out of phpDocumentor, ApiGen, and the like (which is what the chapter is about), the @ tags are useful or even necessary. But you could clarify that purely for code commenting without using those tools, type hinting could suffice.

Xymph avatar Apr 16 '23 13:04 Xymph