Checkstyle guide: CODESTYLE.OFF or CODESTYLE.OFF?

se-edu / addressbook-level3

:ab::three: Address Book sample application (Level 3)

https://se-education.org/addressbook-level3

MIT License

28 stars 415 forks source link

Checkstyle guide: CODESTYLE.OFF or CODESTYLE.OFF? #154

Closed damithc closed 1 year ago

damithc commented 1 year ago

Not directly related to AB3, but can someone investigate https://github.com/nus-cs2103-AY2223S2/forum/issues/77 to see if the guide needs to be updated?

damithc commented 1 year ago

@se-edu/tech-team-level1 Any help with this?

dlimyy commented 1 year ago

I have just tested it and it also only appears to work when CHECKSTYLE.OFF and CHECKSTYLE.ON are used instead of CODESTYLE.OFF and CODESTYLE.ON.

I believe it is due to the value of offCommentFormat and onCommentFormat under SuppressionCommentFilter which is under checkstyle.xml being CHECKSTYLE.OFF and CHECKSTYLE.ON respectively.

We can fix it by either editing the guide or changing the value here to be CODESTYLE instead

damithc commented 1 year ago

Got it. Thanks for checking this @dlimyy I'll update the guide accordingly.