.NET接口上正确的xml注释

你应该记录任何公共成员。如果你已经实现了ISomeInterface.SomeMember成员作为 public void SomeMember 然后应该记录下来。一方面,读者会将其视为类的一部分,只有通过阅读文档(如果没有文档,他们就不知道要查看文档),他们才会知道它是在该接口中定义的。如果它作为 void ISomeInterface.SomeMember 然后它就不那么重要了,因为它不会被视为类的公共接口的一部分。

有时了解特定类如何实现给定接口成员的详细信息也很重要。

另一方面,给出一个非常简短的描述并引导人们访问接口文档以获取更多信息可能是合理的。