XML documentation for accessors.

Collapse
This topic is closed.
X
X
 
  • Time
  • Show
Clear All
new posts
  • Steven Quail

    XML documentation for accessors.

    Hi to all,

    I have just found the XML documentation option in VS.net which
    generates
    a HTML page of the XML tags in a project.

    What I would like to know is if there is an option or a way of getting
    the
    same HTML page but instead of all the methods of a class listed one
    after
    another, what I would like to see is a section (in HTML) for public
    methods,
    another for private methods etc.

    In this way, I will be able to see what interface methods are exposed
    by my objects rather than all the methods.

    TIA
    Steven.
  • Peter Rilling

    #2
    Re: XML documentation for accessors.

    I personally don't like the way VS.NET generates the XML pages because it
    does not use all the tags or allows you much control over appearance. You
    might try a specialized document generator such as nDoc
    (http://ndoc.sourceforge.net/).

    "Steven Quail" <squail71@yahoo .com> wrote in message
    news:3aabc57a.0 310020318.7198d 0da@posting.goo gle.com...[color=blue]
    > Hi to all,
    >
    > I have just found the XML documentation option in VS.net which
    > generates
    > a HTML page of the XML tags in a project.
    >
    > What I would like to know is if there is an option or a way of getting
    > the
    > same HTML page but instead of all the methods of a class listed one
    > after
    > another, what I would like to see is a section (in HTML) for public
    > methods,
    > another for private methods etc.
    >
    > In this way, I will be able to see what interface methods are exposed
    > by my objects rather than all the methods.
    >
    > TIA
    > Steven.[/color]


    Comment

    • Steven Quail

      #3
      Re: XML documentation for accessors.

      Cheers Peter for the reply.

      You would think that when someone else or at a later stage you look at your
      code, it is the public interface that enables to see what your object does.
      I do not want to search through all the methods (private etc) to get an idea
      that my object or someone elses does a few things. The XML documentation is
      no good to me in its current format. Nice idea but not very practical in
      this case.

      I was hoping that there would be a simple option in the IDE that would
      supply the HTML output separated by Public, private, protected etc methods.

      Thanks once again.
      Steven.

      "Peter Rilling" <peter@nospam.r illing.net> wrote in message news:<u6W26nRiD HA.2400@TK2MSFT NGP11.phx.gbl>. ..[color=blue]
      > I personally don't like the way VS.NET generates the XML pages because it
      > does not use all the tags or allows you much control over appearance. You
      > might try a specialized document generator such as nDoc
      > (http://ndoc.sourceforge.net/).
      >
      > "Steven Quail" <squail71@yahoo .com> wrote in message
      > news:3aabc57a.0 310020318.7198d 0da@posting.goo gle.com...[color=green]
      > > Hi to all,
      > >
      > > I have just found the XML documentation option in VS.net which
      > > generates
      > > a HTML page of the XML tags in a project.
      > >
      > > What I would like to know is if there is an option or a way of getting
      > > the
      > > same HTML page but instead of all the methods of a class listed one
      > > after
      > > another, what I would like to see is a section (in HTML) for public
      > > methods,
      > > another for private methods etc.
      > >
      > > In this way, I will be able to see what interface methods are exposed
      > > by my objects rather than all the methods.
      > >
      > > TIA
      > > Steven.[/color][/color]

      Comment

      Working...