最好的方式来记录WCF接口？ [英] Best way to document WCF interface?

问题描述

所以我正在使用WCF，并且要记录我的接口和服务，以给另一家公司提供一个内部应用程序。记录这些界面的最好方式是什么？我希望将文档内置于代码中，然后使用某些特殊的输出HTML，但不确定是否有推荐的方法。

So I'm using WCF, and want to document my interface(s) and services to give to another company for an internal app. What's the best way to document those interfaces? I'd prefer having the documentation inline with the code, and then have something prettify to output HTML, but am not sure if there's a recommended way to do it.

推荐答案

为此使用XML文档。有很多智能元标签可以让您将代码示例放在其中，操作之间的引用，抛出异常等。

Do use XML docs for that. There are a lot of smart meta-tags that will allow you to put code samples in them, references between operations, thrown exceptions etc.

然后可以使用Sandcastle（+一些GUI可以在Codeplex上找到）来生成chm或html文档。

Then you can use Sandcastle (+ some GUI you can find on Codeplex) to generate either chm, or html documentation.

这篇关于最好的方式来记录WCF接口？的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！