Link to home
Start Free TrialLog in
Avatar of MajinLoki
MajinLoki

asked on

VB.Net Comment Web pages

Here's an easy one guys.

I want to build comment web pages.  How do I comment so that my comments appear on the web pages?

Thanks
Majin Loki
Avatar of KGreg
KGreg

What do you mean.. comment web page.. like a blog?

If so, you need a Database driven website.

KGreg
Avatar of MajinLoki

ASKER

No, in Visual Studios, you can create comment web pages that list all methods and attributes of each class/module and put them into a web page with comments, like Javadoc comments for Java.
read this:

http://www.csharphelp.com/archives/archive238.html


Also, I found a quick note about comment web pages.

from: http://www.devhood.com/messages/message_view-2.aspx?thread_id=105391

if you use xml tags in your code to describe everything (i.e. the <summary> tag) it will generate this nice outline of your class structure, kinda like java docs

Hope these help,

KGreg
Can I do this with VB .NET projects?
Yea.. just set up the XML tags in your code.  Then you go to the Code View and click Tools->Build Comment Web Pages

KGreg
the <summary></summary> tags do not work with VB - they throw an error.  if I put hten inside comment delimiters, they don't work either.
hmmm...I think maybe you can't.  I can't believe Microsoft wouldn't give VB this, but it appears that you cannot.  Ofcourse, I'm running VS 2002, not 2003, so maybe they have.

You can create a series of Web pages, called a code comment Web report, that allow you to browse the code structure within files in your current project or solution, such as objects and interfaces defined in a project, and members. Using special code comment syntax, you can also include notes or other information. By default, code comment Web pages are stored in a directory called CodeCommentReport, and this directory is placed in the directory containing the solution file.

Note   Currently, only C# supports the code comment syntax required for code comment Web reports. Additional languages might also support code comment syntax at a later date.

The home page for the code comment Web report lists summary information for the solution. This page is created regardless of whether or not you choose to build a Web report for a solution or just selected projects. Selecting a project from the home page takes you to a summary page for the project and displays a navigation pane. You can then browse the code structure for the project by selecting links from either the project summary page or from the navigation pane. The navigation pane lists all the namespaces within the project. These namespaces include classes, structures, interfaces, enumerators, and delegates.

Oh.. you have 2002.

I believe its supported in 2003.

KGreg
I've also noticed that the code comments, when you run it with VB, do not display Modules.

Are there any free programs out there that would to the same thing for VB.net projects....maybe some sort of VS addin?
ASKER CERTIFIED SOLUTION
Avatar of KGreg
KGreg

Link to home
membership
This solution is only available to members.
To access this solution, you must be a member of Experts Exchange.
Start Free Trial