[RESOLVED] Documentation

Hi All :wave:
I make some user control and the class in the VB.NET , and also make some class library and the common control.
Bu now I want to make the documentation of all the control made by me class made me, So hoe to make the batter documentation of the control and class library made by me in the VB.NET
What are the rules for it and what are the basic thing to remember in the controls and class library documentation? :confused:

Any idea :confused:

Not a specific question regarding .NET or databases.

Moved to General Developer

If using Vb2005, typing 3 single quotes above a method/member etc will create a template for you to fill like:-

VB Code:

''' <summary>
    ''' An abstract base class that a document area writer class must implement 
    ''' to draw data onto a structured print document 
    ''' </summary>
    ''' <remarks>This interface defines teh bare minimum requirement but 
    ''' implementing classes can extend the functionality by implementing
    ''' extra parameters</remarks>
    Public Interface IStructuredPrintDocumentAreaWriterBase

Fill this in and then use the Sandcastle tool (available for free download from Microsoft) to compile it up to a help file that integrates with MSDN help...

I want to make documentation in the word file not in the dot net project :wave:

Bad idea as there will be no link to the project and can easily be lost. Use what was suggested by Merrion and after creating the MSDN help for your control it can then be easily ported into Word

For a user control youi should also consider decorating the class members with the <Description()> and <category()> attributes (from system.componentmodel) so that they play nicely with the property grid in the IDE.

Quote:

---

Originally Posted by Valleysboy1978

Bad idea as there will be no link to the project and can easily be lost. Use what was suggested by Merrion and after creating the MSDN help for your control it can then be easily ported into Word

---

But it is the company requirement so i have to make it in the word file so have you now any idea for it.
I am able to make it but i do not know the proper way

Well if you use Merrion's method, it will output an XML file with the documentation that is above the code. You could then apply a style sheet to that document and render it to HTML.

The problem with a word document is that if a function gets changed, you have to manually update the document, whereas if you keep the info in the code, it can rebuild your docs for you automatically.

Use merrions method above but use nDoc instead - it can output word files IIRC

Thanks to you all