Question

We have code that is called by an external framework, ARDEN. Short of a comment (easily overlooked), how can I effectively notify developers of tie in’s to this framework? Specifically, a tie in couples the CLASS, NAMESPACE and METHOD to said framework.

namespace MyCompany//changing namespace for this class is NOT SAFE
{
public class MyClass//changing class name is NOT SAFE
{
   [TiedToArdenAttribute]//maybe an attribute?
   public void MethodCalledByArden() {}//adding params, changing name is NOT SAFE

   public void NotCalledByArden() {}//changing this method signature, name, params is OK
}
}

Under normal circumstances, for example when I change the name of MyClass in an assembly via visual studio I can’t compile without fixing the references to said class. If the namespace, classname or method name changes…there should be a warning that says “best fix Arden to deal with this change”. I considered an Error, but since there’s no way to verify Arden is fixed I don’t believe that will work.

Is there a way to achieve a similar result for this external framework?

Answer 1

I think whatever you do can be undone by other developers – they can rename class, remove comments, remove attributes.

Try to move this class to separate library instead. And in your project add reference to compiled assembly. That will make class name fixed in your project.