/Community

I'm getting this warning on a parameter called callbackObject and offering to rename it to callback.

Why is this a language specific type name?

Wouldn't callback trigger the same rule?

What am I missing?

Good catch, Paulo!

Shall the rule trigger violation for callbackObject parameter? No, it shouldn't. And yes, it should. The triggered violation in this particular case is somewhat arbitrary. But ultimately the MS guidelines are very clear on this -

"Avoid using language-specific types name in parameters and members and data type identifiers in parameters. Types names might not be intuitive for all developers. It is recommended that you select a generic name, such as 'value', instead. If this is not sufficient, be sure to use the type name as it is defined in the .NET Framework Library and avoid language-specific type names completely."

And even for the callbackObject below:

    public class A
    {
        public void Test(object callbackObject)
        {
        }
    }

"In member 'A.Test(object)', consider replacing the data type identifier 'Object' in parameter name 'callbackObject' with a more generic term, such as 'value'."

After all the parameter callbackObject above is of a type object...

So, while the rule is configured to follow MS guidelines pretty strictly, I do agree with your point. In CodeIt.Right we provide multiple ways to tweak rules to you needs if disagree. In this case you can add callbackObject into the ExcludeList property (comma delimited list) of your instance of the rule "NA00003: AvoidLanguageSpecificTypeNamesInParameters" - this will solve the issue.

Thanks!

Ok. I totally missed that one. I was thinking the it was refering to callback.

I'm not changing it here because it's what it is - an object. I won't do what has been done in some BCL classes like using obj instead.

I do agree that CodeIt.Right should use the same rules as FxCop (and StyleCop).

Instead of an exclude list, why not consider the SupressMessageAttribute?

Paulo,

Paulo Morgado:

I do agree that CodeIt.Right should use the same rules as FxCop (and StyleCop).

Instead of an exclude list, why not consider the SupressMessageAttribute?

We look at this very similar - CodeIt.Right in the default profile is following MS Guidelines :)

As for the SupressMessage attribute, CodeIt.Right does support it and even extends a bit. Here are examples:

// excludes all violations of the Design category
[SuppressMessage("SubMain.CodeItRight.Rules.Design", "")]

// excludes violation by rule ID
[SuppressMessage("SubMain.CodeItRight.Rules.Design", "DE00010")]

// excludes violation by rule name
[SuppressMessage("SubMain.CodeItRight.Rules.Design", "TypesContainStaticMembersShouldBeSealed")]

// excludes violation by rule ID and rule name
[SuppressMessage("SubMain.CodeItRight.Rules.Design", "DE00010:TypesContainStaticMembersShouldBeSealed")]

Is there a list of this suppressions?

This is a strange request, but here it goes: if CodeIt.Right knows the corresponding FxCop or StyleCop rule being supressed, it should also supress its corresponding rule (a supression attribute migth be needed).

Paulo Morgado:

This is a strange request, but here it goes: if CodeIt.Right knows the corresponding FxCop or StyleCop rule being supressed, it should also supress its corresponding rule (a supression attribute migth be needed).

CodeIt.Right does that too :)  It will respect the FxCop SuppressMessage attribute for the FxCop rules that CodeIt.Right has a corresponding rulle.

Paulo Morgado:

Is there a list of this suppressions?

Are you looking for a tutorial? The SuppressMessage attribute takes two arguments - the Rule Category or the Rule ID/Class Name - both of these parameters are optional but one of them is required.

For example:

// exclude category "Design"
[SuppressMessage("SubMain.CodeItRight.Rules.Design", "")] 

// Exclude rule by Rule ID
[SuppressMessage("", "DE00010")] 

// Exclude rule by Rule Name
[SuppressMessage("", "TypesContainStaticMembersShouldBeSealed")] 

// Exclude rule by Rule ID and Rule Name
[SuppressMessage("", "DE00010TypesContainStaticMembersShouldBeSealed")] 

// for the custom rules in the "MyOwnCategory"
[SuppressMessage("MyOwnCategory", "")] 

Is this helpful?

Paulo,

I believe I misread part of your question. I edited my post above.