代码之家 › 专栏 › 技术社区 › driAn

n层应用程序中的方法级文档

data-access-layer documentation architecture web-services c#

0

driAn · 技术社区 · 17 年前

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

(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上还是在webservice上?

我想说,在接口上编写方法规范是最有意义的,因为使用的是契约。然而,在我的具体情况下,我看不到webservice和DAL之间的优势:

我是唯一的开发人员,没有单独的Web服务人员或客户人员需要这些文档
这是一个封闭的体系结构,Web服务不是公共的
未来参与该项目的每个人都将可以访问该项目的所有组件(并可以在任何地方找到文档)

那么,你觉得怎么样?在这种情况下,我应该将方法级文档放在哪里?

1 回复 | 直到 17 年前

1

Godeke 17 年前

如果DAL曾受到另一个客户重用的威胁 web服务层。。。很明显,这改变了事情的方向,使其向另一个方向倾斜(或者使重复的注释自动化)。