正确使用派生类的XML内联文档?

时间:2011-05-11 14:32:43

标签: c# visual-studio-2010 .net-4.0 xml-documentation

虽然我认为我理解为什么内联XML文档(即使用三个斜杠 - ///)对我不起作用,但我想获得一些如何解决我的“问题”的指导。

我有一个接口和两个派生类。一个派生类用于模拟,另一个用于与真实硬件通信。

硬件实现很可能会做一些模拟器不需要做的特殊事情。我有硬件方法的XML文档,而不是模拟器。但是,当我将鼠标悬停在方法名称上时,我根本没有获得工具提示中的文档,大概是因为XML文档与界面没有关联。

这当然有道理,我打算将我的文档放在界面中,并与之共存。我仍然很好奇,但是其他人怎么做到这一点?是否有一些神奇的方法可以使工具提示聚合所有有效的XML文档?换句话说,由于编译器不知道正在使用哪个派生类,是否有办法为实现此接口的所有类显示XML文档?

2 个答案:

答案 0 :(得分:0)

由于您正在编程接口,因此无法从实现中传递XML文档。分离意味着两个“边”彼此不了解。就像你说的那样,你可以有两种不同的接口实现。在这种情况下,你会发生冲突。对于两个人来说这不是什么大不了的事,但200呢?此外,使用界面的关键是你不关心它是如何实现的。您知道当您使用接口时,实现将遵循合同。使用界面上的XML注释来描述合同,而不是合同的实现。

我能感受到你的痛苦,我不确定是否有更好的解决方案。

答案 1 :(得分:0)

这不会解决您的所有问题,但GhostDoc可以使用基类文档快速将文档插入到派生类中。无论如何,如果您正在进行XML文档,那么值得一看。