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

[Peter Rilling]

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.po> wrote in message
news:Ou**************@TK2MSFTNGP10.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

[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.rilling.net> wrote in message
news:%2****************@TK2MSFTNGP12.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.po> wrote in message
news:Ou**************@TK2MSFTNGP10.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

[Peter Rilling]

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" <[e-mail]> wrote in message
news:#Q**************@tk2msftngp13.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.rilling.net> wrote in message
news:%2****************@TK2MSFTNGP12.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.po> wrote in message
news:Ou**************@TK2MSFTNGP10.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

[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.rilling.net> wrote in message
news:uM**************@TK2MSFTNGP10.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" <[e-mail]> wrote in message
news:#Q**************@tk2msftngp13.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.rilling.net> wrote in message
news:%2****************@TK2MSFTNGP12.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.po> wrote in message
news:Ou**************@TK2MSFTNGP10.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
>
>
>
>
>
>

[Peter Rilling]

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" <[e-mail]> wrote in message
news:e9**************@TK2MSFTNGP10.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.rilling.net> wrote in message
news:uM**************@TK2MSFTNGP10.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" <[e-mail]> wrote in message
news:#Q**************@tk2msftngp13.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.rilling.net> wrote in message
news:%2****************@TK2MSFTNGP12.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.po> wrote in message
> news:Ou**************@TK2MSFTNGP10.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
> >
> >
> >
> >
> >
> >
>
>