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

Question

虽然我想我理解为什么内联XML文档（即使用三个斜杠 - ///）不适用于我，我想获得关于如何解决我的“问题”的一些指导。

我有一个接口和两个派生类。一个派生类用于仿真，另一个用于与真实硬件交谈。

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

这当然是有道理的，我打算把我的文档放在界面中，而不是与它一起生活。我仍然很好奇，但是...其他人怎么做呢？是否有一些不可思议的方法可以使工具提示汇总所有有效的XML文档？换句话说，由于编译器不知道正在使用哪个派生类，是否有办法让所有实现此接口的类都显示XML文档？

Answer 1

由于您正在对接口进行编程，因此没有办法通过实现中的XML文档。分离意味着两个“边”彼此不知道。就像你说的那样，你可以有两种不同的接口实现。在这种情况下，你会有冲突。这对两个人来说不是什么大不了的事，但200呢？此外，使用接口的意义在于你不关心它是如何实现的。你知道，当你打电话使用接口时，实施将遵循合同。使用界面上的XML注释来描述合同，而不是合同的实施。

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

Answer 2

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