Docproject - Web Services

Topics: General Discussion, General Questions, Help 1.x/2.x, Sandcastle
Feb 21, 2008 at 4:59 PM
Im a noobie in documentation.
How can i make a chm for a webservice project???
Feb 22, 2008 at 5:43 AM

That depends on the type of the project.

If it's an ASP.NET Web Service Application project that was created using File > New > Project... and selecting the ASP.NET Web Service Application template, which is not available in Visual Studio 2005 unless you install an additional Add-In or Service Pack 1, then you can simply add a project reference in your DocProject or DocSite, enable the Produce Help 1.x setting and then build.

If it's an ASP.NET Web Service project that was created using File > New > Web Site..., I suspect that you'll have to follow the same procedure as for Web Site projects. Basically, you'll have to add some configuration and reference the output as an external source using the External sources option in the DocProject Properties window.

See How to Build Help For a Web Site Project for more information.

Note that a Web Application project is recommended for ease of use. If you have trouble generating documentation for your project then you may want to consider converting it:

Walkthrough: Converting a Web Site Project to a Web Application Project in Visual Studio 2005

- Dave
Mar 18, 2008 at 1:24 PM

NDoc (very fast) or Sandcastle Help File Builder
Mar 18, 2008 at 4:35 PM

SHFB will most likely have the same problems as DocProject when attempting to document a Web Site or Web Service project.

The issue, as I've clearly stated, is that a Web Site or Web Service project does not build an assembly or an XML documentation file when it's built in Visual Studio, so manual steps must be taken.

It's quite possible that NDoc uses the actual source code to auto-generate reference documentation. But I don't think that's true, in which case your suggestion to use a different tool on the basis that Web Service projects are difficult to document using DocProject is without merit because that's equally true for all of the tools that you've mentioned.

There are other proprietary tools that don't use Sandcastle and parse the source code to generate documentation instead of requiring an assembly, so they work without any manual steps. However, I believe that they require you to purchase a license to use them.

- Dave