generating dev documentation from standard commenting.

Collapse
This topic is closed.
X
X
Collapse
 
  • Page of 1
  • Time
  • Show
Clear All
new posts
Previous template Next
  • Miraj Haq
    #1

    generating dev documentation from standard commenting.

    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.Defa ultHttpHandler
    End Class
    ------------------------------

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

    Any ideas, tools, methods available?

    Many thanks,
    Miraj



    Tags: None
    • dkode
      #2
      Re: generating dev documentation from standard commenting.

      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

        Comment

        • Peter Macej
          #3
          Re: generating dev documentation from standard commenting.

          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

            Comment

            • Herfried K. Wagner [MVP]
              #4
              Re: generating dev documentation from standard commenting.

              "dkode" <dkode8@gmail.c om> schrieb:[color=blue]
              > 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[/color]

              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/>

                Comment

                • Miraj Haq
                  #5
                  Re: generating dev documentation from standard commenting.

                  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?

                  "Herfried K. Wagner [MVP]" <hirf-spam-me-here@gmx.at> wrote in message
                  news:uJb08R5RGH A.1844@TK2MSFTN GP12.phx.gbl...[color=blue]
                  > "dkode" <dkode8@gmail.c om> schrieb:[color=green]
                  >> 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[/color]
                  >
                  > 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/>[/color]


                    Comment

                    • Herfried K. Wagner [MVP]
                      #6
                      Re: generating dev documentation from standard commenting.

                      "Miraj Haq" <mirajhaq-n11-o-11s-p-a22-m@yahoo.com> schrieb:[color=blue]
                      > So it means, MS VS 2005 editions are presently missing documentation tool?[/color]

                      Yes.
                      [color=blue]
                      > Its like Microsoft wanted to give its partners the opportunity to build
                      > such tools for users of vs 2005?[/color]

                      Maybe...

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

                        Comment

                        Previous template Next
                        Working...