[RESOLVED] Documentation, Explanation and Annotation of Program Code

[chilling]

We are just about to start a couple on new "major" (or at least major for us) projects and I wanted to create an internal policy to define the way in which we document and annoatate the code:
- is the there a defined methology somewhere for VB.NET code; and
- are there any inbuilt tools in VStudio 2005 to help with this?

[mpdeglau]

Take a look at this
Also if you type ''' you get this

''' <summary>
    ''' 
    ''' </summary>
    ''' <param name="sender"></param>
    ''' <param name="e"></param>
    ''' <remarks></remarks>

When the app is compiled it creates an xml file. There are other nodes you can add to this. Type '''< and intelisense will help you out.

[jmcilhinney]

Further to what mpdeglau posted, those XML files are used by Intellisense to provide descriptions of your properties, methods and arguments. You can also use a tool like NDoc to create MSDN-style CHM documentation for your classes from those files.

[Mr.No]

Also if you type ''' you get this

''' <summary>
        ''' 
        ''' </summary>
        ''' <param name="sender"></param>
        ''' <param name="e"></param>
        ''' <remarks></remarks>

Is this feature available in VS .NET 2003? If not how can I do this?

Thanks

[penagate]

Here is an addin for VS that lets you use XML comments in VB.NET 2003.

http://www.gotdotnet.com/workspaces/...a-86bdf39a17dd

[Mr.No]

I googled after my posting and found VBCommenter PowerToy Development VBCommenter PowerToy Development

[chilling]

Thanks Guys - as I am using VS 2005 the inbuild ''' works just fine for me

[Mr.No]

Here is an addin for VS that lets you use XML comments in VB.NET 2003.

Thanks Penagate.