Add new Sniff to restrict line length in docblocks #171
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR introduces the Sniff
BigBite.Commenting.DocCommentLineLength
. This Sniff allows one to restrict the number of characters allowed on one line in a docblock.The default warning threshold is 80 characters; the default error threshold is 100 characters. Both are configurable.
The line length restriction will not be imposed upon WordPress plugin or theme comments, as their descriptions will generally exceed the default bounds. It will also not apply to lines whose text wholly contains unbreakable strings (such as URIs).
Indentation and
*
do not contribute to the line length calculations by default. This is configurable.So, the following are acceptable by default:
This will trigger a warning:
And this will trigger an error:
Usage
To disable this rule:
To override the default config:
Types of changes (if applicable):
Checklist (if applicable):