GrandpaB

Dear VB'ers

I'm attempting to create a well documented class. I have created a XML file by typing ''' before each method and property in the class. I am now looking for a way to render the XML file into a user friendly .chm file. I have downloaded and installed NDoc, but it does not seem compatable with .NET 2.0. Do you have any suggestions how I might create the documentation Thanks.




Re: Visual Basic Express Edition XML Documentation

ReneeC

Wow Grandpa....

For once I can help you. However.... all the capabilities may not be in VBE.

The proper way to accomplish what you want is to do an XSLT transform on the XML into HTML and then process the HTML with FAR or HTML workshop to create a .chm file.

I fear VBE lacks an XML/XSLT editor and only has an XML editor.

I have posted updated examples of what to do perhaps no in this forum but in one of the other VB fora. Please see http://forums.microsoft.com/MSDN/ShowPost.aspx PostID=1259240&SiteID=1

The example is from a knowledge base article but the the article itself was not up to date and as far as I know my adaptation is the only correct one.

It is an example of XML - > RTF if I remember correctly. HTM transforms are far simpler and you can google XML to HTML transform for more information and examples.






Re: Visual Basic Express Edition XML Documentation

GrandpaB

ReneeC,

WOW and Shazam! I'll be busy for some time sifting through the procedure that you suggested. It may be the best solution, but was hoping to find a more automated procedure. Yesterday, I stumbled on a 17 page, MSDN article written by Wei-Meng Lee in 2005, "Generating Documentation for Your Visual Basic .NET Applications." The URL for the article is :

http://msdn2.microsoft.com/en-us/library/aa289191(VS.71).aspx.

The article outlines how to use VBCommenter (which I think is now built into VB Express) to create an XML file and then use NDoc to create the documentation. NDoc was shown to convert the XML documentation into a MSDN-style HTML Help format (.chm) file.

NDoc is a free open-source tool from SourceForge. That's the good part; the bad is is that it only works with older versions of .NET. Aargh! Is there another solution






Re: Visual Basic Express Edition XML Documentation

ReneeC

Grandpa we cross posted.

What I showed you was an XML -> RTF conversion. HTML is MUCH simpler. Please see my modified post above.






Re: Visual Basic Express Edition XML Documentation

GrandpaB

ReneeC,

I downloaded a trial softwre package and sucessfully converted the XML to HTML. I then imported the HTML help file into HTMLHelp and created a .CHM file. The results, to say the least, were very disappointing. First, the XML file generated in VB 2005 must not include all the tags that were included inVBCommenter/VB .Net. The VB 2005 XML file does not include the names of the Constructors, Properties and Methods. The HTML file that was created is a single page so the CHM file wwas just a single page.

Looking at the article that I previously mentioned. The CHM file had a tree view for each element in the assembly. There were major headings for Constructors, Properties and Methods. Under each major heading were the individual elements. It looked as if it had been pulled from MSDN documentation. Yesterday when I found the article I was elated; today I'm deflated.

The combination of VBCommenter and NDoc seemed to make a very powerful and useful documentation package. It is seriously lacking in VB Express. Is the ability to create documentation any better in the full versions of VB






Re: Visual Basic Express Edition XML Documentation

GrandpaB

I'm going to mark this thread as closed as I assume that there is not a replacement for NDoc.

Thanks for you help.