如果有一个接口和一个实现它的类，并且您希望在其上添加 xml 注释以在 VS intellisense 或文档中使用，您会将 xml 注释放在哪里？在接口的方法上还是在具体的类方法上？正确的方法是什么？
我的想法是将它放在接口中，因为我们正在使用接口声明变量。而且我认为如果我也对具体类发表评论并看到这可能会导致同一方法的不同文档是多余的。
有什么想法、建议吗？
问问题
740 次
1 回答
3
您应该记录任何公共成员。如果您已经实现了 ISomeInterface.SomeMember，public void SomeMember那么它应该被记录在案。一方面，读者会将此视为您课程的一部分，并且只有通过阅读文档（如果不存在，他们无法知道查看），他们才会知道它是在该接口中定义的。如果它被实现void ISomeInterface.SomeMember那么它就不那么重要了，因为它不会被视为类的公共接口的一部分。
有时了解特定类如何实现给定接口成员的详细信息也很重要。
另一方面，给出一个非常简短的描述并将人们引导到界面的文档以获取更多信息可能是合理的。
于 2010-08-17T01:54:40.690 回答