VB.NET XML Documentation Help


R

Ray75

Hello,
I've been all over sourceforge, Codplex, Devex, codeproject,
msdn, and the net looking for an answer to both exporting and then
formating the XML comments (''') in my vb code to some sort of
documentation. I've downloaded and failed using nDoc, Snadcastle, and
a couple others except the pricey doc-o-matic.

One site says to simply
* Document your C# source code by using the XML documentation
tags.
* Extract the XML documentation tags to an XML file.
* Tell NDoc where it can find the extracted XML file and the
assembly associated with it-that is the .dll or .exe file.
but I can't even figure out how to extract the XML.

Sorry if I come off abrasive, I just feel very stupid at this
point. If anyone out there in computerland knows what I should be
looking for please let me know.

All I want to do is take something like...
''' <summary>
''' Builds out the URL including the application root, path to
page, and optionally the server name and the Http/Https
''' </summary>
''' <param name="PathFromAppRoot">A string representing the path
starting just after the root path</param>
''' <param name="IsOrgSpecficPage">A boolean value indicating
whether you want the Organization specific path</param>
''' <param name="IncludeServerName">A boolean value indicating if
you want the server name in the string path</param>
''' <param name="UseSSl">A boolean value indicating whether you
want to begin with http or https</param>
''' <returns>The URL with the indicated options</returns>
''' <remarks></remarks>
Public Shared Function BuildUrl(ByVal PathFromAppRoot As String,
Optional ByVal IsOrgSpecficPage As Boolean = False, Optional ByVal
IncludeServerName As Boolean = True, Optional ByVal UseSSl As Boolean
= False) As String

End Sub

and create documentation for all the classes in the project.
 
Ad

Advertisements

H

Herfried K. Wagner [MVP]

Ray75 said:
I've been all over sourceforge, Codplex, Devex, codeproject,
msdn, and the net looking for an answer to both exporting and then
formating the XML comments (''') in my vb code to some sort of
documentation. I've downloaded and failed using nDoc, Snadcastle, and
a couple others except the pricey doc-o-matic.

Somewhere in "My Project" options of your project in the VS IDE there is an
option which, if enabled, causes generation of an XML documentation file
("Generate XML documentation" or similar). This file has the name of the
assembly with an ".xml" extension appended. The XML documentation file can
be used as input for NDOC (which does not support .NET 2.0, BTW), and I
assume it can be used together with Sandcastle (which is the preferred
solution now) too.
 
R

Ray75

Thanks Herfried, but we're setup as a website and not a project and
that option doesn't appear. I have tried compilerOptions=/doc+ and
doc:filename with no luck.

Thanks.
 
R

Ray75

Thanks Herfried, but this is a VS.net website rather than a "project".
I've tried using the compilerOptions=/doc+ and doc:filename option in
the compilation section of my web.config, but with no success and an
error stating that the compilerOptions attribute is not declared.

Thanks!
 
R

Ray75

Further investigation has revealed that in a "Project" I can go to
properties and select "Generate XML documentation file" as stated here
http://msdn2.microsoft.com/en-us/library/f64ezf9b(VS.80).aspx.
Unfortunately in an asp.net 2.0 website I don't have that.

I then read that the *compilerOptions="doc:<filepath>* option in the
web.config should work, but I get "The compilerOptions attribute is
not declared" while compiling.
 
Ad

Advertisements

P

Peter Macej

Ad

Advertisements


Ask a Question

Want to reply to this thread or ask your own question?

You'll need to choose a username for the site, which only take a couple of moments. After that, you can post your question and our members will help you out.

Ask a Question

Top