CODEWITHSUNDEEP
c#.net
Isaac Levin
Isaac Levin

Reputation: 2899

.Net tool to Document Methods

I have been asked by my company to document all of our .Net web services and provide the signatures (ie inputs and outputs) for all the methods of those services. Is there a tool out there that will do this and return a document or summary. This would save me a lot of time and stop me from having to look through a bunch of code.

Thanks!

Upvotes: 1

Views: 208

Answers (5)

Mrchief
Mrchief

Reputation: 76208

Sancastle is the most used one I think.

Amongst others there's:

If you do not have existing XML comments in the source code, GhostDoc plugin offers great help in generating standard boilerplate comments which can be modified later.

Upvotes: 1

Eric Farr
Eric Farr

Reputation: 2713

We use doxygen for this with pretty good success. You can see examples linked from this page.

Upvotes: 3

mservidio
mservidio

Reputation: 13057

Sandcastle. See this on a quick how-to. Sandcastle Help File Builder is extremely useful.

Sandcastle creates msdn like documentation. We use GhostDoc within Visual Studio to do the actual commenting on everything.

Upvotes: 1

Stephen Cleary
Stephen Cleary

Reputation: 456457

GhostDoc is great for getting an initial start to documenting undocumented code.

The XML docs can then be exported via SandCastle Help File Builder, a good UI frontend for Sandcastle, resulting in HTMLHelp, HTML, and MS Help File Viewer outputs.

Upvotes: 2

Yuck
Yuck

Reputation: 50835

You can add XML comments to methods like this:

    /// <summary>
    /// Method summary.
    /// </summary>
    /// <param name = "asdf">Parameter description.</param>
    /// <returns>Return value summary.</returns>
    public object SomeMethod(object asdf) {
        return null; // but really, do something fun
    }

Upvotes: 2

Related Questions