-
-
Notifications
You must be signed in to change notification settings - Fork 3.8k
Closed
Milestone
Description
https://checkstyle.org/config_misc.html#AvoidEscapedUnicodeCharacters
Add example for each existing config to show what code is ok and what code cause violation.
Good example is https://checkstyle.org/config_naming.html#AbstractClassName
Please add examples for all properties of Check.
Make xdoc to follow structure as we have in other Checks: config is following by code example where trailing comment "// violation" is placed on the same line our CLI will show.
look at referenced commits of #5832, to see what and how should be changed in code.
please play with module/Check by means of https://checkstyle.org/cmdline.html to understand how it works.
PLEASE READ https://github.com/checkstyle/checkstyle/wiki/Good-practice-on-how-to-update-examples