CODEWITHSUNDEEP
.netvb.netdocumentation-generation
Mselmi Ali
Mselmi Ali

Reputation: 327

Source Code Documentation tool

Can any one suggest a source code documentation tool for VB.NET 10 ?

Thanks.

Upvotes: 3

Views: 3059

Answers (3)

Scott C Wilson
Scott C Wilson

Reputation: 20026

We use DocumentX.

Upvotes: 4

Marc Gravell
Marc Gravell

Reputation: 1062865

If you want your documentation to contain anything except the things that are already obvious from the signature, the only useful tool here is... you. That and some /// (C#) or ''' (VB) fun. There are tools that will generate things like "gets or sets the FrobCount", but ultimately... what did you think the FrobCount {get;set;} property did?

BTW, by this I don't mean "don't bother adding those comments" - they do have some sense... but my concern is that you get into the habit of just using the automatic tooling. Ultimately, this adds very little extra value. The value comes from knowledge about the semantics, expected usage, side-effects etc. No automated tool will generate that.

Upvotes: 4

Neil Knight
Neil Knight

Reputation: 48547

GhostDoc is what I use. Great tool.

Upvotes: 5

Related Questions