0

我的情况：

我的应用程序的数据请求链如下所示：

(Client) -> (WebService) -> (SQL or OLAP Cube)

客户端是一个 Silverlight 应用程序，它使用生成的代理与 WCF Web 服务进行通信。反过来，它使用 DAL 组件进行授权和访问 SQL DB 和 OLAP 多维数据集，基本上它只是转发请求。因此，每种方法存在于四个不同的地方：

// WCF Webservice interface and implementation (used by client)
public interface ICatalogService 
public class CatalogService : ICatalogService

// DAL interface and implementation (used by webservice)
public interface ICatalogDataAccessLayer
public class CatalogDataAccessLayer : ICatalogDataAccessLayer

现在我的问题是，我应该在哪里放置文档以明确指定这些方法？在类或接口级别上，在 DAL 上还是在 Web 服务上？

到目前为止我的想法：

我会说在接口上编写方法规范最有意义，因为它是正在使用的合约。但是，在我的具体情况下，我看不到 webservice 和 DAL 之间的优势：

  • 我是唯一的开发人员，没有单独的 webservice-guy 或 client-guy 需要文档
  • 这是一个封闭的架构，webservice 不公开
  • 将来从事此项目的每个人都可以访问它的所有组件（并且无论在哪里都可以找到文档）

那么，你怎么看呢？在这种情况下，我应该将方法级文档放在哪里？

4

1 回答 1

1

我认为大多数人会期望 Web 服务的文档比 DAL 更多（特别是如果 DAL 主要是生成的代码：我猜是因为这些是传递方法）。我会在 DAL 注释中为将来使用它的人添加指向 Web 服务文档的指针。

原因是双重的。首先，Web 服务是真正的交互点（因此可能会添加更多客户端，这意味着记录服务是一个优势）。第二个是 DAL 听起来确实不像它在 Web 服务（在所描述的配置中）提供“附加价值”，所以回到交互和价值的真正点是有道理的。

如果 DAL 曾经受到另一个没有Web 服务层的客户端重用的威胁......显然这会改变事情以相反的方式（或自动重复评论）。

于 2009-05-01T21:22:49.700 回答