Home | Contact Us | FAQ | Search & Site Map | Link to Us
Sign In | Join | Other 45 Sites in Network
HomeAnnouncementsFree MagazinesWhite PapersSubmit Content
Discussion GroupsASP.NETWindows FormsLanguages.NET FrameworkVisual Studio.NET
Articles.NET FrameworkASP.NETToolsWindows Forms
.NET DirectoryOpen Source ProjectsUser GroupsWeb Resources
Related Topics
Visual Basic 6SQL ServerMS AccessOther DB ProductsMS Server ProductsMore Topics ...

.NET Forum / Visual Studio.NET / General / December 2005

Tip: Looking for answers? Try searching our database.

VS.Net XML Doc

Thread view: 
Enable EMail Alerts  Start New Thread
Thread rating: 
Joe Titanieri - 04 Dec 2005 17:31 GMT
Is it possible to use the built in XML Doc functionality of VS to create full
documentation even inside the methods?

Example:

///<summary>
/// standard summary tag (I know how this works)
/// </summary>
void MyMethod() {
 
   /// Initialization
  Init();

  /// process data
  DoSomething();
}

//end of example

Now I would like to generate the documentation and I need to get also the
comments inside of MyMethod.
So I would get with the documentation of MyMethod also the lines:

Initialization
process data

I didn't find any tools that do this, I think VS cannot do this... Generally
I would need something like the good old CWeb Tangle/Weave for C#.
Kevin Spencer - 04 Dec 2005 19:54 GMT
The XML Documentation tools in Visual Studio will only read the special XML
Comments, not all remarks tags. It would certainly be possible to write your
own parser to extract all the comments and format them as XML, and then
write an XSLT that transforms this to an HTML format of your choosing.

It should also be noted that you can extend the recommended set of tags in
the special comments sections with whatever elements and attributes you may
wish to add.

Signature

HTH,

Kevin Spencer
Microsoft MVP
.Net Developer
You can lead a fish to a bicycle,
but you can't make it stink.

> Is it possible to use the built in XML Doc functionality of VS to create
> full
[quoted text clipped - 26 lines]
> Generally
> I would need something like the good old CWeb Tangle/Weave for C#.

Free Magazines

Get these publications absolutely FREE for up to 12 months. There are no hidden fees and no obligation. Simply choose a title, complete the application form and submit it. Read more ...

Oracle MagazineNetwork ComputingComputer WorldBio-IT WorldeWeekInformation WeekInfosecurity
 
Sign In
Join
My Latest Posts
My Monitored Threads
My Blog
My Photo Gallery
My Profile
My Homepage

Start New Thread
Enable EMail Alerts
Rate this Thread



©2008 Advenet LLC   Privacy Policy - Terms of Use
This website includes both content owned or controlled by Advenet as well as content owned or controlled by third parties.