GhostDoc 2.1.1 Release: For programmers who hate writing documentation

home
c#
view story

21 Kicks

GhostDoc 2.1.1 Release: For programmers who hate writing documentation(weblogs.asp.net)

submitted by powerrush(3873) 4 years, 7 months ago

Unlike nDoc or Sandcastle, this tool doesn't generate the end-result documentation, rather, it's a VS add-in that _automatically_ writes the XML documentation in your C# code! What it generates is based upon a set of editable rules.

5 comments |category: C# |Views: 52
Tweet

tags: documentation Comments XmlComments C# GhostDoc another

Everyones tags:

Your Tags:

Please login or signup.

Add a live kick counter to your blog >> liveImage

You can even customize the image by choosing your own colors, and then clicking the button below to update the preview and the html code:

"Kick It" text
"Kick It" background
kick count text
kick count background
border

Simply copy and paste this HTML into your blog post.

Users who kicked this story:

ashithmr(90) -

korayem(1240) -

roelof(120) -

marco.ragogna(0)

More who kicked this story...

Comments:

posted by powerrush(3873) 4 years, 7 months ago 0

Sorry, I don't have a tool suggestion for the programmers that LOVE writing documentation, if any exist (the doc-loving programmer or the tool). ;)

posted by jamesewelch(2275) 4 years, 7 months ago 0

I love this tool :)

I've used it for years since the VS 2003 version.

This along with Regionerate keeps my code clean, commented, and well organized.

This works great with nDoc (haven't tested it with Sandcastle yet). Basically, you use Ghostdoc to add XML comments and then nDoc to generate documentation from the XML comments in your code.

posted by w3stfa11(645) 4 years, 7 months ago 0

Did this replace NDoc?

posted by jamesewelch(2275) 4 years, 7 months ago 0

No, GhostDoc generates XML Comments.
nDoc reads the Xml Comments and creates the documents.
They work in partnership but they don't overlap in functionality.

SandCastle is MS's version of nDoc that will hopefully replace nDoc since nDoc is now dead.

SandCastle story is at http://www.dotnetkicks.com/clr/Sandcastle_September_2007_Community_Technology_Preview_CTP

posted by cdjaco(5) 4 years, 7 months ago 0

I've been using GhostDoc for quite a while now. Excellent tool.

Most Active Users

What's this?