应该如何对接口和类方法的意见不同

Question

我在使用Web客户端软件工厂（WCSF）在C＃中ASP.net Web应用程序工作时碰到了这个难题，同样也适用于其他平台和语言。我的情况是这样的：

我定义的I 查看界面基于WCSF范例每个网页/用户控制，那么有页类实现我查看界面，基本上实现每个的接口中定义的方法的。当我试图在方法级添加XML的文档，我发现自己基本上重复对于接口方法的注释内容相同，并且在实现类其反一部分。

所以我的问题是：应该有在界面方法的文档的内容和对应的类之间的方法的一些显着差异？他们应该是强调在不同的方面的东西？

有人告诉我，该接口方法的评论应该说“什么”的方法应该做的事，和类方法中的注释应该说是“如何”做的。但我记得在此之前，该方法级注释应该只说“做什么”的方法应该做的事，从来没有方法的实现细节，因为执行不应该成为法用户关心的问题，它可能会改变。

Answer 1

我个人认为，这些意见应该是相同的 - 都应该说“什么方法是要干什么”，在你的条件

。

有没有理由对XML注释提的实现细节。一个例外，潜在地，应该提到的潜在的副作用。（即：该方法可能需要很长的时间），但我个人做，在的XML文档注释的<remarks>部分

Answer 2

给我打电话螺母，但我会用一个描述性名称的方法和收工（无评论为两种）。如果一些事情令人惊讶的是我可以添加注释实现或为什么它有不明显的。