XML文档说明是否应该使用Sand Castle进行WCF服务的接口或实现？

Question

我之前从未使用过SandCastle，所以我有一个noob问题。

我想记录一个WCF服务，我想使用SandCastle来完成它。文档注释应该在OperationContracts的接口级别，还是应该在Implementation类的方法上？或两者兼而有之？

Answer 1

这主要是个人/团队的选择，具体取决于您的需求和愿望。

我使用Sandcastle来记录接口和实现类。我这样做是为了我的团队的内部文档，而不是服务的外部客户 - 我为他们提供了一个不同的文档。

我推荐两者的原因是两个不同的类可以以完全不同的方式实现相同的合同。保持界面上的代码文档非常简单，然后在实现类中提供更多文档（备注，代码示例等），涵盖实现类＆＃39;功能。

这将允许其他开发人员（或您自己在路上）了解接口提供的内容（需要），以及实现类实现接口中指定的功能的方式/方式。