/Community

Hi,

 We have a guideline that member fields should start with m_ (e.g. m_engineType). I can indeed make such a rule.

For static member fields however, we use s_ (e.g. s_dataProtection). Also this rule can be made fairly easy, changing the scope to Static only.

The problem is that the m_ rule is also executed for the static member fields, even though Static is not ticked in the Scope. I guess that's because the scope includes "Private", and that this field is indeed also private.

Is there a way to solve this?
 

You are right it's tricky when your field is both private and static in the scenario you described.

I don't have solution off the top of my head but I will this by the other dev team folks this week and get back to you.

Thank you for the feedback! 

Hi Serge,

In the mean time I bought a license, but actually forgot this was still a pending issue.

Is there already a way to solve it? E.g. a hidden NonStatic scope classification that I could add in the xml file?
 

Hi Jurgen,

Currently this only can be worked around with a custom rule.

We are willing to develop that rule for you - please just tell us exactly what you want to achieve  

Hi Serge,

These are our naming conventions:

The problem lays in the fact that we want to see from the name whether a field is static or not.

So, for static fields we use the prefix s_ followed by Camel Case: e.g. s_nextId.

For non-static member fields we use the prefix m_ followed by Camel Case e.g. m_stationPosition;

As you can see, this is not possible as is with Codeit.Right since

1) all conditions are "or'd"

2) all rules are checked. There is no way to chnage the order and to say "if this rule aplies, don't check that other rule any more".

Thanks for helping me out!

 
Jurgen
 

Jurgen,

Please find two custom rules attached to this post (with source code).

You will need to copy the CustomRules\CustomRules\bin\Debug\CustomRules.dll file to "c:\Program Files\SubMain\CodeIt.Right\Rules\" and then add the two new rules to your profile - http://community.submain.com/blogs/howto/archive/2008/01/24/how-to-add-rule-to-user-profile.aspx

Alternatively, you can merge the inner part of the SubMain.CodeItRight.RulesEngine.RulesProfile node below into your profile:

<SubMain.CodeItRight.RulesEngine.RulesProfile Name="My Profile" Description="" Author="">
  <CustomRules.UsePrefixForStaticMember>
    <Scopes>Public, ProtectedInternal, Private, Abstract, Sealed, Readonly, Virtual, Override, Extern, Unsafe, SpecialName, Const, Volatile, WriteOnly, WithEvents, Default</Scopes>
    <Status>Active</Status>
    <Targets>Field</Targets>
    <Severity>Warning</Severity>
    <Title>Use "s_" prefix for static fields</Title>
    <Name>Static field -> Use "s_" prefix</Name>
    <NextCharCapitalizationStyle>Lower</NextCharCapitalizationStyle>
    <PrefixToCheck>s_</PrefixToCheck>
  </CustomRules.UsePrefixForStaticMember>
  <CustomRules.UsePrefixForNonStaticMember>
    <Scopes>Public, ProtectedInternal, Private, Abstract, Sealed, Readonly, Virtual, Override, Extern, Unsafe, SpecialName, Const, Volatile, WriteOnly, WithEvents, Default</Scopes>
    <Status>Active</Status>
    <Targets>Field</Targets>
    <Severity>Warning</Severity>
    <Title>Use "m_" prefix for non-static fields</Title>
    <Name>Non-static fields -> Use "m_" prefix</Name>
    <NextCharCapitalizationStyle>Lower</NextCharCapitalizationStyle>
    <PrefixToCheck>m_</PrefixToCheck>
  </CustomRules.UsePrefixForNonStaticMember>
</SubMain.CodeItRight.RulesEngine.RulesProfile>

Please let me know how these working out for you.

Hi Serge,

 
This works like a charm. Thanks a lot. You guys are really a refreshing company to work with.

 
Jurgen

 

Jurgen,

Thank you!

This is the best compliment for us!