sheitmann / AgentSmith

Agent Smith is C# code style validation plugin for ReSharper (Visual Studio plugin).
GNU General Public License v2.0
16 stars 7 forks source link

Feature request: Ability to ignore specific identifier requiring meta-tag. #19

Closed Neonalig closed 1 year ago

Neonalig commented 2 years ago

Often times when documenting methods, you use words such as 'this' without intending to talk about the base class. (such as in the example below) image

Adding the ability to ignore 'WordCanBeSurroundedWithMetaTags' for specific words (i.e. 'this') would greatly enhance the user experience as they are no longer forced to wrap the word in <c></c> to indicate the identifier is not intended, or to add a comment suppression. This would perhaps be implemented as an 'identifier suggestion blacklist', allowing users to specify words they almost certainly don't want hints for, and can simply add the meta-tag themselves if required without being warned.

sheitmann commented 1 year ago

@Neonalig There is already an option for this. Go to the ReSharper Options and below Tools -> AgenSmith -> XML Documentation -> General you will find "Regular Expression patterns to ignore for metatagging". When you add "this" to the list, it will not be highlighted anymore. grafik