cakephp-codesniffer: Inline doc blocks

According to https://phpdoc.org/docs/latest/guides/docblocks.html#anatomy-of-a-docblock even inline doc blocks, like we have in quite a few places, e.g.

/* @var \Cake\ORM\Entity $node */

should start with /** actually:

/** @var \Cake\ORM\Entity $node */

Any objections to fix that and provide a sniffer for it?

About this issue

Original URL
State: closed
Created 8 years ago
Reactions: 2
Comments: 19 (13 by maintainers)

Commits related to this issue

Allow doc comments inside classes to be at any indentation level Addresses bug acknowledged in discussion at https://github.com/cakephp/cakephp-codesniffer/issues/172#issuecomment-261802729 — committed to BallStateCBER/cakephp-codesniffer by PhantomWatson 7 years ago

Most upvoted comments

Yes. Those are official Doc Blocks then. See the token parse Result. No Matter if multi or single Line they need to start with /**. All other comments /* and // are considered Text only, they have no special structure and semantic meaning.

dereuromark on Feb 6, 2017