xml comments in a class


G

Guest

Hello,

When I do something like this before a method:

/// <summary>
/// Load the file from disk
/// </summary>
/// <param name="FileName">Set the filename, preferred extention is
".xml"</param>

Then the comment is visible in the code completition. But when I create a
separate class and use it, then it is not visible. Do I forget something here
?

I'm using C#2005 beta express.
 
Ad

Advertisements

G

Guest

Hello Bob,
Build the XML documentation file and distribute it along with your DLL

Thanks. Only problem is I cannot find any menu item on how to build the XML
documentation. Maibe it is a limitation in the Express version ?

Problem is nobody seems to know what the differences of limitations are in
the Express version. I use C# 2005 Express Beta.
 
B

Bob Powell [MVP]

I don't have the express version but here's how I'd do it in the VS2003
enterprise edition...

Open the solution browser, right click on the project within the solution.
Select "Properties" and then the "Cration Properties" sub-tree.
Select the "Build" section and ensure tht the XML Documentation File in the
"Outputs" section has a file name such as "bin/myassembly.xml"

The XML comments will be assembled in the named XML file which you can copy
along with the DLL.

--
Bob Powell [MVP]
Visual C#, System.Drawing

Find great Windows Forms articles in Windows Forms Tips and Tricks
http://www.bobpowell.net/tipstricks.htm

Answer those GDI+ questions with the GDI+ FAQ
http://www.bobpowell.net/faqmain.htm

All new articles provide code in C# and VB.NET.
Subscribe to the RSS feeds provided and never miss a new article.
 
B

Bob Powell [MVP]

Why "Configuration" ended up as "Cration" I'll never know


--
Bob Powell [MVP]
Visual C#, System.Drawing

Find great Windows Forms articles in Windows Forms Tips and Tricks
http://www.bobpowell.net/tipstricks.htm

Answer those GDI+ questions with the GDI+ FAQ
http://www.bobpowell.net/faqmain.htm

All new articles provide code in C# and VB.NET.
Subscribe to the RSS feeds provided and never miss a new article.





Bob Powell said:
I don't have the express version but here's how I'd do it in the VS2003
enterprise edition...

Open the solution browser, right click on the project within the solution.
Select "Properties" and then the "Cration Properties" sub-tree.
Select the "Build" section and ensure tht the XML Documentation File in the
"Outputs" section has a file name such as "bin/myassembly.xml"

The XML comments will be assembled in the named XML file which you can copy
along with the DLL.

--
Bob Powell [MVP]
Visual C#, System.Drawing

Find great Windows Forms articles in Windows Forms Tips and Tricks
http://www.bobpowell.net/tipstricks.htm

Answer those GDI+ questions with the GDI+ FAQ
http://www.bobpowell.net/faqmain.htm

All new articles provide code in C# and VB.NET.
Subscribe to the RSS feeds provided and never miss a new article.
 
Ad

Advertisements

G

Guest

Hi Bob,

wont work :(
maybe tis is a limitation in the Express version.. It is a pretty that
nobody knows about this and it is nowhere published.
thanks for help !
 
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