PHPCSStandards / PHP_CodeSniffer / 11586688823

79%

push

github

Squiz/PostStatementComment: use a different error code for annotations (#627)

This commit changes `Squiz.Commenting.PostStatementComment` to use a
different error code when an annotation is found. This will allow
ruleset maintainers to selectively exclude the flagging of trailing
annotations from their ruleset. For example, for PHPCS itself, this will
make it possible to use the `// @codeCoverageIgnore` annotation where
needed.

An annotation is defined as any comment that starts with an optional
space, followed by a `@` and any character, as long as it is not a
whitespace. For now, only `//` comments are supported as this is the only
type of comment supported by this sniff.

This change only applies to PHP code as support for JS will be dropped
soon, and JS doesn't seem to follow the same convention of annotations
starting with `@`.

6 of 6 new or added lines in 1 file covered. (100.0%)

23476 of 30939 relevant lines covered (75.88%)

63.06 hits per line