如果有一个接口(interface)和一个实现它的类，并且您希望在 VS 智能感知或文档中使用它的 xml 注释，您会将 xml 注释放在哪里？在接口(interface)的方法上还是在具体的类方法上？正确的做法是什么？
我的想法是把它放在接口(interface)中，因为我们使用接口(interface)声明变量。而且我认为如果我还在具体类上添加注释并看到这可能会导致同一方法出现不同的文档，那么它是多余的。
有什么想法、建议吗？
最佳答案
您应该记录任何公共(public)成员。如果您已将 ISomeInterface.SomeMember 实现为 public void SomeMember 那么应该对其进行记录。一方面，读者会将其视为类的一部分，并且只有通过阅读文档(如果不存在，他们就无法知道要查看文档)，他们才会知道它是在该接口(interface)中定义的。如果它实现为 void ISomeInterface.SomeMember 那么它就不那么重要，因为它不会被视为类的公共(public)接口(interface)的一部分。
有时了解有关特定类如何实现给定接口(interface)成员的详细信息也很重要。
另一方面，给出非常简短的描述并引导人们查看界面的文档以了解更多信息可能是合理的。
关于c# - .NET 接口(interface)上正确的 xml 注释，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/3498741/