6

Is there a way to create compile time errors if a certain method is called?

As an example, what I'd like to do is prevent code in a certain project from calling System.Configuration.ConfigurationManager.AppSettings(). Is there a way to tag the project or class file to raise a compile time error IF that method is called?

I don't think there is, so my thought is that the only way to do this is to generate an FxCop rule that would flag these calls and do it that way, but I am open to other ideas.

I am using .NET 3.5. Not sure if 4.0 code contracts can do this.

Updates

I am specifically talking about framework methods, not my own, so I cannot mark them as Obsolete.

At this point I don't care about reflection.

Another example is System.Web.HttpUtility.HtmlEncode, which I want to find and replace with Microsoft's AntiXss library, but I'd like to integrate some sort of check process on my build server that would check new code as well.

slolife
  • 19,520
  • 20
  • 78
  • 121

2 Answers2

4

You are able to write your own rules in FxCop so perhaps that's an option.

However, in this case, for existing code-base you might find that a Ctrl-F (Find) in your editor for "ConfigurationManager.AppSettings" might do an equally good job with far less effort... With regards to future enforcement though you might consider a more human route of an email memo to the development team...

As highlighted by a commenter above and worth noting for others with similar goals, is that if this were referring to a function in your own code-base (which this question is not referring to), you could use the [Obsolete] attribute.

Reddog
  • 15,219
  • 3
  • 51
  • 63
  • While I agree that an email **should** work, I'd like something a little more concrete in terms of validation. – slolife Nov 16 '11 at 21:55
  • 1
    Maybe tell the team they owe a 6-pack of beer to the rest of the team for breaking coding standards!? In all seriousness, FxCop with a custom rule will help you validate it, but that's only as long as the dev's (or a build server) install the rule(s) and use FxCop properly... – Reddog Nov 16 '11 at 22:41
2

The tool NDepend can be used for that (Disclaimer: I am one of the developers of the tool).

You can write some Code Rules over LINQ Queries (CQLinq) to check any kind of dependency, like a method call for example. Code rules can be checked in Visual Studio after each successful compilation, or rules can be checked at build process time as well.

Such a CQLinq code rule can look like:

warnif count > 0 
from m in Application.Methods         
where m.IsUsing("System.Configuration.ConfigurationManager.get_AppSettings()")
select m

The rule can be specialized at whim, to forbid for example namespaces that match a regex, to contain methods that call the get_AppSettings() getter method:

warnif count > 0 
from m in Application.Namespaces.WithNameLike("regex").ChildMethods()
where m.IsUsing("System.Configuration.ConfigurationManager.get_AppSettings()")
select m

From the NDepend dependency matrix or dependency graph, you can also right click a dependency (matrix cell or graph arrow) and generate a code rule that warns if the dependency exist (and then specialize the rule generated if you need):

enter image description here

Patrick from NDepend team
  • 13,237
  • 6
  • 61
  • 92