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

问题描述

所以我使用WCF，并希望我的文档接口（S）和服务给另一家公司的一个内部应用程序。什么是记录这些接口的最佳方法？我倒是preFER有与code中的文档内联，然后有一些prettify输出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文档了点。有很多聪明的元标签，让你把code样品在其中，业务之间的引用，引发的异常等。

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.

然后你可以使用沙堡（+一些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屋！