C#学习教程:让svcutil从C#文件中获取文档?分享


让svcutil从C#文件中获取文档?

伙计们,

我正在创建一个新的WCF服务,并从我的服务界面开始。 看起来像:

public interface ISomethingService { ///  /// some description ///  /// 2.13.0 /// 2009 by myself /// Marc Scheuner /// The request object [OperationContract] SomethingResponse GetList(SomethingRequest request); } 

现在,我还在另一个描述SomethingRequest和SomethingResponse消息的文件中创建了一些数据协定。

我编译了我的项目并启动了svcutil.exe以从DLL中提取元数据(WSDL和XSD) – 但我似乎无法弄清楚是否有办法将我的所有注释和解释都放到WSDL / XSD中/节点。

我是否对另一个不起眼的svcutil.exe参数视而不见,或者真的没有办法在元数据中自动生成这个文档?

编辑:好的,根据Marc Gravell的回答,注释和文档字符串不在编译的DLL中,也不在MEX元数据交换协议上可用(可惜!)。

那么:如果您需要向第三方提供访问您服务所需的信息,您如何记录您的WCF服务? 是否存在“NService”或“Sandcastle for WCF”工具,它将扫描我的WCF服务库并从源代码构建WSDL和XSD,包括注释?

似乎无法找到很多工具和方法来做到这一点 – 令我惊讶的是,老实说….

svcutil.exe使用“mex”API,只能访问元数据的子集。 评论不包括在内(IIRC,也是[DescriptionAttribute]在很大程度上)。

您可能必须依赖外部文档(即帮助页面/死树)。 另一个选择(虽然它打破了许多纯SOA规则)是在dll + xml中发布实体/接口; svcutil(和IDE)可以重用现有程序集中的匹配类型。

也许这有帮助: http : //msdn.microsoft.com/en-us/library/aa717040.aspx

它也适用于svcutil。

上述就是C#学习教程:让svcutil从C#文件中获取文档?分享的全部内容,如果对大家有所用处且需要了解更多关于C#学习教程,希望大家多多关注—猴子技术宅(www.ssfiction.com)

本文来自网络收集,不代表猴子技术宅立场,如涉及侵权请点击右边联系管理员删除。

如若转载,请注明出处:https://www.ssfiction.com/ckf/960019.html

发表评论

邮箱地址不会被公开。 必填项已用*标注