Embeded XML Documentation 
Author Message
 Embeded XML Documentation

The C# language allows you embed XML Documentation in your code.

/// <summary>
/// Does nothing when called.
/// </summary>
public void MyMethod()
{
//donothing

Quote:
}

I know you can even have all the documentation written out to an XML file
when you compile the code by using the "/doc:myclass.dll.xml" switch with
csc.

What I want to know is how to embed this documentation in the assembly so
it's available via intelisense in visual studio when referencing the
compiled assembly.

Thanks, Shawn



Mon, 28 Mar 2005 20:18:48 GMT  
 Embeded XML Documentation
Shawn,

    I'm not exactly sure that you can.  If you look at the directory where
the common assemblies are held (System.dll, mscorlib.dll, etc, etc) you will
notice that the XML file is there in the directory with the assembly.  You
can always have your installer place the XML file in the directory with the
assembly.

    Hope this helps.

--
               - Nicholas Paldino [.NET/C# MVP]


Quote:
> The C# language allows you embed XML Documentation in your code.

> /// <summary>
> /// Does nothing when called.
> /// </summary>
> public void MyMethod()
> {
> //donothing
> }

> I know you can even have all the documentation written out to an XML file
> when you compile the code by using the "/doc:myclass.dll.xml" switch with
> csc.

> What I want to know is how to embed this documentation in the assembly so
> it's available via intelisense in visual studio when referencing the
> compiled assembly.

> Thanks, Shawn



Mon, 28 Mar 2005 21:00:15 GMT  
 Embeded XML Documentation
Thanks, that helps a lot!



Quote:
> Shawn,

>     I'm not exactly sure that you can.  If you look at the directory where
> the common assemblies are held (System.dll, mscorlib.dll, etc, etc) you
will
> notice that the XML file is there in the directory with the assembly.  You
> can always have your installer place the XML file in the directory with
the
> assembly.

>     Hope this helps.

> --
>                - Nicholas Paldino [.NET/C# MVP]



> > The C# language allows you embed XML Documentation in your code.

> > /// <summary>
> > /// Does nothing when called.
> > /// </summary>
> > public void MyMethod()
> > {
> > //donothing
> > }

> > I know you can even have all the documentation written out to an XML
file
> > when you compile the code by using the "/doc:myclass.dll.xml" switch
with
> > csc.

> > What I want to know is how to embed this documentation in the assembly
so
> > it's available via intelisense in visual studio when referencing the
> > compiled assembly.

> > Thanks, Shawn



Mon, 28 Mar 2005 21:34:03 GMT  
 
 [ 3 post ] 

 Relevant Pages 

1. XML documentation

2. Getting XML documentation to appear in assembly

3. Good Xml Style Sheets for Documentation

4. XML Documentation in MC++?

5. Using XML documentation in Managed C++

6. Sample xslt to convert xml documentation to html pages

7. Documentation XML

8. XML documentation problems

9. Preserving XML Documentation when compiling DLL

10. XML documentation

11. Extending XML Documentation

12. XML Documentation

 

 
Powered by phpBB® Forum Software