我正在实现一个类,该类使用非常严格定义的模式封装 xml 文档。我不控制架构。
类中的属性之一用于模式指示必须与特定正则表达式匹配的元素值。在属性的设置器中,如果字符串与表达式不匹配,我将引发异常。
我的问题是,如何才能更好地向我班级的用户传达该领域的要求?有我可以使用的属性吗? Xml 注释(所以它显示在智能感知中)?除了抛出异常之外,我还应该做些什么吗?我还有什么其他选择?
如果您随程序集一起提供 XmlComments 可能会有所帮助,但我想说,如果不满足要求,最好不要抛出异常,并使异常消息尽可能详细。如果当用户调用依赖于该属性的方法/属性时未满足要求,我也会抛出异常(同样有很多细节)。
您实际上无法采取任何措施来阻止使用该代码的人第一次犯错误,但是当错误确实发生时,您应该尽可能清楚地了解如何纠正它。
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)