c# - 为派生类正确使用 XML 内联文档？

Question

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

我有一个接口和两个派生类。一个派生类用于模拟，另一个用于与真实硬件对话。

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

这当然是有道理的，我打算只将我的文档放在界面中并使用它。不过，我仍然很好奇……其他人是怎么做到的？有什么神奇的方法可以让工具提示聚合所有有效的 XML 文档吗？换句话说，由于编译器不知道正在使用哪个派生类，有没有办法为实现该接口的所有类显示 XML 文档？

Answer 1

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

Answer 2

由于您正在对接口进行编程，因此无法从实现中传递 XML 文档。分离意味着两个“方”彼此不了解。就像您说的，您可以对该接口有两种不同的实现。在这种情况下，你会有冲突。这对两个人来说没什么大不了的，但是200个呢？此外，使用接口的意义在于你不关心它是如何实现的。你知道当你调用使用接口时，实现将遵循契约。使用接口上的 XML 注释来描述契约，而不是契约的实现。

我能感觉到你对此的痛苦，我不确定是否有更好的解决方案。