Clarify documentation about optional param and return tags in docblock
Closed this issue · 1 comments
Xerkus commented
Currently documentation mentions phpDoc tags @param
and @return
as being optional and in some cases undesirable. However it is done briefly and in a way that is easy to gloss over unless you already know what you are looking for.
Code SHOULD be written so it explains itself. DocBlocks and comments SHOULD only be used if necessary. They MUST NOT start with # and MUST NOT be empty. They SHOULD NOT be used for already typehinted arguments, except arrays.
I believe it is fairly significant rule and should be elevated to its own block that also includes code example.
geerteltink commented
Fixed in #45