generating dev documentation from standard commenting.

14 Mar 2006 7:18 AM

Miraj Haq

Hi,

I was amazed to see the new feature of "Insert Comment" on right click
context menu over a sub routine or a class in vb.net.

I can see using standard commenting mechanism, i can see help in
intellisense and object browser. I am looking for ways to generate
documentation (chm, or latest formats)
from
-----------------------------
"
''' <summary>
''' Used to handle custom requests
''' </summary>

''' <remarks>The class CustomHandler is designed to handle custom http
requests, you can do blah blah in order to achieve something</remarks>
Public Class CustomHandler
Inherits System.Web.DefaultHttpHandler
End Class
------------------------------

and from
------------------------------
''' <summary>
''' Allows direct access to request being received.
''' </summary>
''' <returns>Returns the value</returns>
''' <remarks>Function OverrideExecuteUrlPath allows to override aspnet
handling mechanism</remarks>
Public Overrides Function OverrideExecuteUrlPath() As String
Return "/default.aspx" 'MyBase.OverrideExecuteUrlPath
End Function
--------------------------------

Any ideas, tools, methods available?

Many thanks,
Miraj

14 Mar 2006 1:20 PM

dkode

take a look at NDoc, its on sourceforge. Not sure if they have
framework 2.0 support yet, but it does alot with the xml code comments

14 Mar 2006 6:24 PM

Herfried K. Wagner [MVP]

"dkode" <dko***@gmail.com> schrieb:
> take a look at NDoc, its on sourceforge. Not sure if they have
> framework 2.0 support yet, but it does alot with the xml code comments

No, it unfortunately doesn't support .NET 2.0.

--
M S Herfried K. Wagner
M V P <URL:http://dotnet.mvps.org/>
V B <URL:http://classicvb.org/petition/>

15 Mar 2006 1:01 PM

Miraj Haq

Thanks all of you for replies!

So it means, MS VS 2005 editions are presently missing documentation tool?

Its like Microsoft wanted to give its partners the opportunity to build such
tools for users of vs 2005?

Show quoteHide quote

"Herfried K. Wagner [MVP]" <hirf-spam-me-here@gmx.at> wrote in message
news:uJb08R5RGHA.1844@TK2MSFTNGP12.phx.gbl...
> "dkode" <dko***@gmail.com> schrieb:
>> take a look at NDoc, its on sourceforge. Not sure if they have
>> framework 2.0 support yet, but it does alot with the xml code comments
>
> No, it unfortunately doesn't support .NET 2.0.
>
> --
> M S Herfried K. Wagner
> M V P <URL:http://dotnet.mvps.org/>
> V B <URL:http://classicvb.org/petition/>

15 Mar 2006 4:52 PM

Herfried K. Wagner [MVP]

"Miraj Haq" <mirajhaq-n11-o-11s-p-a2***@yahoo.com> schrieb:
> So it means, MS VS 2005 editions are presently missing documentation tool?

Yes.

> Its like Microsoft wanted to give its partners the opportunity to build
> such tools for users of vs 2005?

Maybe...

--
M S Herfried K. Wagner
M V P <URL:http://dotnet.mvps.org/>
V B <URL:http://classicvb.org/petition/>

14 Mar 2006 2:00 PM

Peter Macej

If you don't mind commercial product, you can try our VBdocman .NET. It
fully supports .NET 2.0 with generics and partial classes.

--
Peter Macej
Helixoft - http://www.vbdocman.com
VBdocman - Automatic generator of technical documentation for VB, VB
..NET and ASP .NET code