文档ASMX webservice

Question

我正在开发一个Web服务来为不同的用户发布消费。

为了平滑他们的工作，我想记录我的所有网络方法及其输入/输出对象，就像下面的图片一样（我在网上看到的样本）。

我只是尝试使用WebMethodAttribute来装饰我的方法，但我唯一能实现的是方法描述。

我尝试使用WCFExtras，但不适合我的项目，因为它不是WCF服务：/

我问：有什么工具可以做这种工作吗？有谁知道要使用的.NET属性或框架？

Answer 1

我对Sandcastle和标准C# XML Documentation的组合感到满意。

基本上，您可以像平常一样注释方法（在类型或方法名称前面键入///以生成注释框架）。然后，在项目上启用enable XML documentation output。最后，您使用工具（例如，Sandcastle）来使用生成的XML文件来构建帮助文件/网站。

在Sandcastle的案例中，它产生了一个CHM。我个人喜欢将API视为CHM文件。还有其他工具可以使它成为一个网站。