Printable View
Hello all! For the first time, I've been asked to write some documentation on a class. Basically the design, properties, methods, etc... Has anyone ever had to do this before? I just need to type something up in MS Word. Can anyone help me get started on that? Thanks!
I've attached what I've done so far, but fear that it isn't very good. ANY advice would be great. Thanks!
UML seems to be the best way to do it (as far as thoroughness and structure is concerned), but it's kind of a pain.
http://www.uml.org/
NDoc is a good way to go, as Briantcva suggests. The functionality to create XML documentation is already built into VS. If you're using VB.NET 2003 then you'll need this plug-in to be able to have XML comment blocks built automatically, otherwise you just type three single quotes for VB or three slashes for C# and press Enter. The block is built for you and you just populate the tags. When you build your project an XML documentation file is created, which NDoc can then turn into a CHM help file. You can take a look at my ZIP CodeBank submission for an example of what it can do. If you take a look at the source you can see where all the information comes from. It's a good idea to read some MSDN topics to get a feel for how Microsoft write their documentation, then add your own flavour as desired.