在使用C#中的Web客户端软件工厂(WCSF)处理ASP.net Web应用程序时,我遇到了这种困境,同样适用于其他平台和语言.我的情况是这样的:
我正在为基于WCSF范例的每个网页/用户控件定义一个I View界面,然后让页面类实现I View界面,基本上实现界面中定义的每个方法.当我尝试在方法级别添加xml文档时,我发现自己基本上重复了接口方法的相同注释内容,以及它在实现类中的反向部分.
所以我的问题是:接口方法的文档内容和相应的类方法之间是否存在一些实质性的区别？他们应该在不同方面强调什么？
有人告诉我,接口方法注释应该说该方法应该做什么,而类方法注释应该说"它是如何做的".但是我记得在之前的某处读过方法级别注释应该只说"该方法应该做什么",而不是方法的实现细节,因为实现不应该是方法用户的关注,它可能会改变.
RESTful和文档/消息风格似乎是现在实现Web服务的两种趋势.通过这个,我的意思是REST与SOAP,文档风格与RPC风格.
我的问题是REST与文档式Web服务的兼容性如何.根据我对REST的有限知识,它利用http GET/POST/PUT/DELETE谓词对URL表示的远程资源执行类似CRUD的操作,这使得它更加"繁琐"和远程方法一样,即RPC样式.另一方面,文档样式的Web服务强调粗粒度调用,即发送具有复杂信息的批处理请求文档,并期望响应文档也返回复杂信息.我无法看到如何通过REST很好地完成它,而不是只为"响应"声明一个资源并且一直使用POST动词(这将破坏REST的目的).
由于我是文档风格和RESTful Web服务的新手,请原谅我,并请指出,在上述假设中的任何无知.谢谢!