473,322 Members | 1,403 Online
Bytes | Software Development & Data Engineering Community
Post Job

Home Posts Topics Members FAQ

Join Bytes to post your question to a community of 473,322 software developers and data experts.

xml comments in a class

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.

--
rgds, Wilfried
http://www.mestdagh.biz
Nov 16 '05 #1
5 1057
Build the XML documentation file and distribute it along with your 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.

"Wilfried Mestdagh" <Wi**************@discussions.microsoft.com> wrote in
message news:95**********************************@microsof t.com...
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.

--
rgds, Wilfried
http://www.mestdagh.biz

Nov 16 '05 #2
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.

--
rgds, Wilfried
http://www.mestdagh.biz
Nov 16 '05 #3
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.

"Wilfried Mestdagh" <Wi**************@discussions.microsoft.com> wrote in
message news:37**********************************@microsof t.com...
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.

--
rgds, Wilfried
http://www.mestdagh.biz

Nov 16 '05 #4
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 [MVP]" <bob@_spamkiller_bobpowell.net> wrote in message
news:eA****************@TK2MSFTNGP09.phx.gbl...
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.

"Wilfried Mestdagh" <Wi**************@discussions.microsoft.com> wrote in
message news:37**********************************@microsof t.com...
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.

--
rgds, Wilfried
http://www.mestdagh.biz


Nov 16 '05 #5
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 !

--
rgds, Wilfried
http://www.mestdagh.biz
Nov 16 '05 #6

This thread has been closed and replies have been disabled. Please start a new discussion.

Similar topics

2
by: Tim Haughton | last post by:
Open question - is it possible to inherit comments along with an interface or class?? For example - I have a class that implements IXPathNavigable. When VS creates te method stub for me, it...
12
by: Sunny | last post by:
Hi All, I have a serious issue regarding classes scope and visibility. In my application, i have a class name "TextFile", and also a few other classes like "TotalWords", "TotalLines" and etc..,...
9
by: Jim Starcher | last post by:
I cannot get the intellisense hints to work on my class constructors. Would you please tell me what I am doing wrong? public class MyObject { //Constructors /// <summary> /// Used to...
5
by: Nick Flandry | last post by:
I'm running into an Invalid Cast Exception on an ASP.NET application that runs fine in my development environment (Win2K server running IIS 5) and a test environment (also Win2K server running IIS...
3
by: Rob T | last post by:
OK....trivial question, but would be nice to have....: Let's say I have simple class like this: Public Class EMailer Public As String ' The Internet address of the recipient Public From As...
98
by: tjb | last post by:
I often see code like this: /// <summary> /// Removes a node. /// </summary> /// <param name="node">The node to remove.</param> public void RemoveNode(Node node) { <...> }
15
by: =?Utf-8?B?R2Vvcmdl?= | last post by:
Hello everyone, I met with a strange issue that derived class function can not access base class's protected member. Do you know why? Here is the error message and code. error C2248:...
8
by: elmosik | last post by:
Is there any method to get this informations from php file? 1. Class methods 2. Check whether class in file is extended by 'XXX' or not (class MyClass extends XXX ...) - Class has same name...
37
by: Phlip | last post by:
1230987za wrote: Kanze is a classically-trained "unit tester". In some circles "unit" is a QA concept - specifically, if a test fails, you only need to inspect one unit. So "units" are...
0
by: DolphinDB | last post by:
Tired of spending countless mintues downsampling your data? Look no further! In this article, you’ll learn how to efficiently downsample 6.48 billion high-frequency records to 61 million...
0
by: ryjfgjl | last post by:
ExcelToDatabase: batch import excel into database automatically...
1
isladogs
by: isladogs | last post by:
The next Access Europe meeting will be on Wednesday 6 Mar 2024 starting at 18:00 UK time (6PM UTC) and finishing at about 19:15 (7.15PM). In this month's session, we are pleased to welcome back...
0
by: Vimpel783 | last post by:
Hello! Guys, I found this code on the Internet, but I need to modify it a little. It works well, the problem is this: Data is sent from only one cell, in this case B5, but it is necessary that data...
0
by: ArrayDB | last post by:
The error message I've encountered is; ERROR:root:Error generating model response: exception: access violation writing 0x0000000000005140, which seems to be indicative of an access violation...
1
by: CloudSolutions | last post by:
Introduction: For many beginners and individual users, requiring a credit card and email registration may pose a barrier when starting to use cloud servers. However, some cloud server providers now...
1
by: Defcon1945 | last post by:
I'm trying to learn Python using Pycharm but import shutil doesn't work
1
by: Shællîpôpï 09 | last post by:
If u are using a keypad phone, how do u turn on JavaScript, to access features like WhatsApp, Facebook, Instagram....
0
isladogs
by: isladogs | last post by:
The next Access Europe User Group meeting will be on Wednesday 3 Apr 2024 starting at 18:00 UK time (6PM UTC+1) and finishing by 19:30 (7.30PM). In this session, we are pleased to welcome former...

By using Bytes.com and it's services, you agree to our Privacy Policy and Terms of Use.

To disable or enable advertisements and analytics tracking please visit the manage ads & tracking page.