Document ASMX webservice

Question

I'm developing a web service to publish for different users consume.

To smooth their work I want to document all my web methods, and their input/output objects, just like on the image below (its a sample that i saw on web).

I just tried to use WebMethodAttribute's to decorate my methods, but the only thing I achieved was the method description.

I tried to use WCFExtras but does not fit in my project because its not a WCF service:/

I ask: is there any kind of tool to do this kind of job? Does anyone knows any .NET property or framework to use?

Answer 1

I've been happy with a combination of Sandcastle and standard C# XML Documentation .

Basically, you comment the methods as you normally do (type /// right before the type or method name to generate the comment skeleton). Then, you enable enable XML documentation output on the project. Finally, you use a tool (for example, Sandcastle) to consume the generated XML file to build a help file/web site.

In Sandcastle's case, it generates a CHM. I personally like viewing the API as a CHM file. There are other tools to make this a Web site.