473,698 Members | 2,932 Online
Bytes | Software Development & Data Engineering Community
+ Post

Home Posts Topics Members FAQ

how to make available the C# documentation in my DLL assembly

AA
Hello, I was commented my class and copile it, when the compilation finished
th VS create the XML document
It is cool because I can use to generate MSHelp documentation but, when I
import my commented assembly from another project, and use it I can see any
comments

I want to see the documentation at runtime, for example when I invoke a
function

MyStr = GetName(int Id)
id: The identification number of the person // <-- This is my
documentation, in the source code is ok, but at runtime i can't see
Thanks a lot


Nov 15 '05 #1
5 5542
The XML file needs to be in the same folder as the assembly. When you
reference an assembly, it gets shadow copied from so that your project can
bind to it. Unfortunately VS.NET does not take the comment file with it.
You will need to manually copy the XML file into the folder where your
assemblies are copied to.

"AA" <ae**@pla.net.p o> wrote in message
news:Ou******** ******@TK2MSFTN GP10.phx.gbl...
Hello, I was commented my class and copile it, when the compilation finished th VS create the XML document
It is cool because I can use to generate MSHelp documentation but, when I
import my commented assembly from another project, and use it I can see any comments

I want to see the documentation at runtime, for example when I invoke a
function

MyStr = GetName(int Id)
id: The identification number of the person // <-- This is my
documentation, in the source code is ok, but at runtime i can't see
Thanks a lot


Nov 15 '05 #2
AA
So, all classes of the .NET CLR have their xml file separated?

Is not possible to embed the xml file?

Thanks

"Peter Rilling" <pe***@nospam.r illing.net> wrote in message
news:%2******** ********@TK2MSF TNGP12.phx.gbl. ..
The XML file needs to be in the same folder as the assembly. When you
reference an assembly, it gets shadow copied from so that your project can
bind to it. Unfortunately VS.NET does not take the comment file with it.
You will need to manually copy the XML file into the folder where your
assemblies are copied to.

"AA" <ae**@pla.net.p o> wrote in message
news:Ou******** ******@TK2MSFTN GP10.phx.gbl...
Hello, I was commented my class and copile it, when the compilation

finished
th VS create the XML document
It is cool because I can use to generate MSHelp documentation but, when I import my commented assembly from another project, and use it I can see

any
comments

I want to see the documentation at runtime, for example when I invoke a
function

MyStr = GetName(int Id)
id: The identification number of the person // <-- This is my
documentation, in the source code is ok, but at runtime i can't see
Thanks a lot



Nov 15 '05 #3
Not all "classes" but rather all physical assemblies have their own XML
file.

No, you cannot embed the XML file in the assembly and have it work the same
way. They must be separate.
"AA" <aa@personal.ne t.py> wrote in message
news:#Q******** ******@tk2msftn gp13.phx.gbl...
So, all classes of the .NET CLR have their xml file separated?

Is not possible to embed the xml file?

Thanks

"Peter Rilling" <pe***@nospam.r illing.net> wrote in message
news:%2******** ********@TK2MSF TNGP12.phx.gbl. ..
The XML file needs to be in the same folder as the assembly. When you
reference an assembly, it gets shadow copied from so that your project can
bind to it. Unfortunately VS.NET does not take the comment file with it. You will need to manually copy the XML file into the folder where your
assemblies are copied to.

"AA" <ae**@pla.net.p o> wrote in message
news:Ou******** ******@TK2MSFTN GP10.phx.gbl...
Hello, I was commented my class and copile it, when the compilation finished
th VS create the XML document
It is cool because I can use to generate MSHelp documentation but, when I import my commented assembly from another project, and use it I can
see any
comments

I want to see the documentation at runtime, for example when I invoke

a function

MyStr = GetName(int Id)
id: The identification number of the person // <-- This is my
documentation, in the source code is ok, but at runtime i can't see
Thanks a lot




Nov 15 '05 #4
AA
Thanks a lot Peter for your time.
I have a last question...

How the assembly take the xml file, I need to put the same assembly name to
the xml?

Or I need to configure something at the compile time

Thanks
"Peter Rilling" <pe***@nospam.r illing.net> wrote in message
news:uM******** ******@TK2MSFTN GP10.phx.gbl...
Not all "classes" but rather all physical assemblies have their own XML
file.

No, you cannot embed the XML file in the assembly and have it work the same way. They must be separate.
"AA" <aa@personal.ne t.py> wrote in message
news:#Q******** ******@tk2msftn gp13.phx.gbl...
So, all classes of the .NET CLR have their xml file separated?

Is not possible to embed the xml file?

Thanks

"Peter Rilling" <pe***@nospam.r illing.net> wrote in message
news:%2******** ********@TK2MSF TNGP12.phx.gbl. ..
The XML file needs to be in the same folder as the assembly. When you
reference an assembly, it gets shadow copied from so that your project can bind to it. Unfortunately VS.NET does not take the comment file with it. You will need to manually copy the XML file into the folder where your
assemblies are copied to.

"AA" <ae**@pla.net.p o> wrote in message
news:Ou******** ******@TK2MSFTN GP10.phx.gbl...
> Hello, I was commented my class and copile it, when the compilation
finished
> th VS create the XML document
> It is cool because I can use to generate MSHelp documentation but, when
I
> import my commented assembly from another project, and use it I can
see any
> comments
>
> I want to see the documentation at runtime, for example when I
invoke a > function
>
> MyStr = GetName(int Id)
> id: The identification number of the person // <-- This is my
> documentation, in the source code is ok, but at runtime i can't see
>
>
> Thanks a lot
>
>
>
>
>
>



Nov 15 '05 #5
Right, the name of the XML file must be the name of the assembly. For
example, MyAssembly.xml and MyAssembly.dll.

You can see how the framework does it by looking in the install folder for
all the assemblies. Here you will see a collection of XML files that
provide the intellisense support for VS.NET.

"AA" <aa@personal.ne t.py> wrote in message
news:e9******** ******@TK2MSFTN GP10.phx.gbl...
Thanks a lot Peter for your time.
I have a last question...

How the assembly take the xml file, I need to put the same assembly name to the xml?

Or I need to configure something at the compile time

Thanks
"Peter Rilling" <pe***@nospam.r illing.net> wrote in message
news:uM******** ******@TK2MSFTN GP10.phx.gbl...
Not all "classes" but rather all physical assemblies have their own XML
file.

No, you cannot embed the XML file in the assembly and have it work the

same
way. They must be separate.
"AA" <aa@personal.ne t.py> wrote in message
news:#Q******** ******@tk2msftn gp13.phx.gbl...
So, all classes of the .NET CLR have their xml file separated?

Is not possible to embed the xml file?

Thanks

"Peter Rilling" <pe***@nospam.r illing.net> wrote in message
news:%2******** ********@TK2MSF TNGP12.phx.gbl. ..
> The XML file needs to be in the same folder as the assembly. When you > reference an assembly, it gets shadow copied from so that your project
can
> bind to it. Unfortunately VS.NET does not take the comment file
with it.
> You will need to manually copy the XML file into the folder where
your > assemblies are copied to.
>
> "AA" <ae**@pla.net.p o> wrote in message
> news:Ou******** ******@TK2MSFTN GP10.phx.gbl...
> > Hello, I was commented my class and copile it, when the compilation > finished
> > th VS create the XML document
> > It is cool because I can use to generate MSHelp documentation but, when
I
> > import my commented assembly from another project, and use it I
can see
> any
> > comments
> >
> > I want to see the documentation at runtime, for example when I

invoke
a
> > function
> >
> > MyStr = GetName(int Id)
> > id: The identification number of the person // <-- This is my
> > documentation, in the source code is ok, but at runtime i can't

see > >
> >
> > Thanks a lot
> >
> >
> >
> >
> >
> >
>
>



Nov 15 '05 #6

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

Similar topics

2
1660
by: Roberto Rocco | last post by:
Hello, Whenever I use methods from my class libraries I don't get any Intellisense support of the source documentation I supplied. When I use the same code directly instead (i.e. adding the class directly to my project and not using the assembly dll of my class library) then I get Intellisense information of the methods as expected. Using third party assemblies instead provides me with the intellisense support. Is there something...
1
1194
by: Joseph Grant | last post by:
Help! I'm a newbie, and would like some info on this please: I have a project that requires me to write my own class. So far everything is working well, my class is working and compiling just fine. However, it sure would be nice to be able use the methods and properties from my class and have the 'intellisence' show up when I use them in VisualStudio. BTW, I am using VS2003. I have tried to do the 'three slashes' so that I can...
10
4573
by: Jon Davis | last post by:
Namespaces don't have <summary> documentation (do they?), and I think it would be nice to have it. For instance, /// <summary> /// Classes containing math functions. /// </summary> namespace BillyBob.Math { ... }
5
1445
by: Bob Rundle | last post by:
I've been looking at the XML documentation for C# code. I've put in a number of <summary>, <remarks>, <param> tags and used the /doc switch to create an XML file. What now? I was expecting to have a style sheet or some other mechanism to present the documentation. I was also expecting to have the summary and params show up in IntelliSense.
14
1606
by: Don Wash | last post by:
Hi There! In C# you can use /// to add comments that can produce XML documentation. What about in VB???? Thanks, Don
6
2619
by: Jeremy S. | last post by:
Sorry if this is too far OT - I posted this in the IIS group and got no response - so here goes: What would be a good or recommended way to make a Web site in IIS6 inaccessible to users on the Internet. My situation is that I will periodically update a ASP.NET Web application. While I am making the update (which will take only a couple of minutes, max) and subsequently checking that everything works as planned after the update (which may...
19
2274
by: Swaregirl | last post by:
Hello, I would like to build a website using ASP.NET. I would like website visitors to be able to download code that I would like to make available to them and that would be residing on my personal server. Are there any code samples or books that someone can recommend so that I can implement this. I would prefer VB.NET code, but I am willing to convert from C# if necessary.
5
1491
by: WStoreyII | last post by:
Is there some sort of a preset way for compiling documetation about an assembly or a project. The Reason that i ask this is that sometimes when i look at examples for code i see things like this. <summary>This is a summary</summary> public function test() end function and then this is the same stuff that i will see in the documentation. if this is the case how do i set this up or compile it?
1
1280
by: the intelligence xml file | last post by:
How can i make the intelligence xml file for a .net assembly? Thanks in advance!
0
8611
by: Hystou | last post by:
Most computers default to English, but sometimes we require a different language, especially when relocating. Forgot to request a specific language before your computer shipped? No problem! You can effortlessly switch the default language on Windows 10 without reinstalling. I'll walk you through it. First, let's disable language synchronization. With a Microsoft account, language settings sync across devices. To prevent any complications,...
0
9031
jinu1996
by: jinu1996 | last post by:
In today's digital age, having a compelling online presence is paramount for businesses aiming to thrive in a competitive landscape. At the heart of this digital strategy lies an intricately woven tapestry of website design and digital marketing. It's not merely about having a website; it's about crafting an immersive digital experience that captivates audiences and drives business growth. The Art of Business Website Design Your website is...
0
8876
tracyyun
by: tracyyun | last post by:
Dear forum friends, With the development of smart home technology, a variety of wireless communication protocols have appeared on the market, such as Zigbee, Z-Wave, Wi-Fi, Bluetooth, etc. Each protocol has its own unique characteristics and advantages, but as a user who is planning to build a smart home system, I am a bit confused by the choice of these technologies. I'm particularly interested in Zigbee because I've heard it does some...
1
6531
isladogs
by: isladogs | last post by:
The next Access Europe User Group meeting will be on Wednesday 1 May 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 a new presenter, Adolph Dupré who will be discussing some powerful techniques for using class modules. He will explain when you may want to use classes instead of User Defined Types (UDT). For example, to manage the data in unbound forms. Adolph will...
0
5867
by: conductexam | last post by:
I have .net C# application in which I am extracting data from word file and save it in database particularly. To store word all data as it is I am converting the whole word file firstly in HTML and then checking html paragraph one by one. At the time of converting from word file to html my equations which are in the word document file was convert into image. Globals.ThisAddIn.Application.ActiveDocument.Select();...
0
4372
by: TSSRALBI | last post by:
Hello I'm a network technician in training and I need your help. I am currently learning how to create and manage the different types of VPNs and I have a question about LAN-to-LAN VPNs. The last exercise I practiced was to create a LAN-to-LAN VPN between two Pfsense firewalls, by using IPSEC protocols. I succeeded, with both firewalls in the same network. But I'm wondering if it's possible to do the same thing, with 2 Pfsense firewalls...
0
4624
by: adsilva | last post by:
A Windows Forms form does not have the event Unload, like VB6. What one acts like?
1
3052
by: 6302768590 | last post by:
Hai team i want code for transfer the data from one system to another through IP address by using C# our system has to for every 5mins then we have to update the data what the data is updated we have to send another system
3
2007
bsmnconsultancy
by: bsmnconsultancy | last post by:
In today's digital era, a well-designed website is crucial for businesses looking to succeed. Whether you're a small business owner or a large corporation in Toronto, having a strong online presence can significantly impact your brand's success. BSMN Consultancy, a leader in Website Development in Toronto offers valuable insights into creating effective websites that not only look great but also perform exceptionally well. In this comprehensive...

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.