PC Review


Reply
Thread Tools Rate Thread

XML documentation for accessors.

 
 
Steven Quail
Guest
Posts: n/a
 
      2nd Oct 2003
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.
 
Reply With Quote
 
 
 
 
Peter Rilling
Guest
Posts: n/a
 
      2nd Oct 2003
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" <(E-Mail Removed)> wrote in message
news:(E-Mail Removed)...
> 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.



 
Reply With Quote
 
Steven Quail
Guest
Posts: n/a
 
      3rd Oct 2003
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" <(E-Mail Removed)> wrote in message news:<(E-Mail Removed)>...
> 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" <(E-Mail Removed)> wrote in message
> news:(E-Mail Removed)...
> > 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.

 
Reply With Quote
 
 
 
Reply

Thread Tools
Rate This Thread
Rate This Thread:

Posting Rules
You may not post new threads
You may not post replies
You may not post attachments
You may not edit your posts

BB code is On
Smilies are On
[IMG] code is On
HTML code is Off
Trackbacks are On
Pingbacks are On
Refbacks are Off


Similar Threads
Thread Thread Starter Forum Replies Last Post
c# accessors ramo9941 Microsoft C# .NET 2 23rd Jul 2008 03:54 AM
Some .NET XML documentation tags are not recognized when I update my solution's documentation Will Pittenger Microsoft C# .NET 8 20th Apr 2004 01:16 AM
ANN: Documentrix - Source Code Documentation/Database Documentation Tool livewire Microsoft VB .NET 0 10th Sep 2003 12:26 PM
ANN: Documentrix - Source Code Documentation/Database Documentation Tool livewire Microsoft Dot NET 0 10th Sep 2003 12:25 PM
ANN: Documentrix - Source Code Documentation/Database Documentation Tool livewire Microsoft C# .NET 0 10th Sep 2003 12:25 PM


Features
 

Advertising
 

Newsgroups
 


All times are GMT +1. The time now is 11:38 PM.