XML documentation on an interface

  • Thread starter Thread starter Karsten Schramm
  • Start date Start date
K

Karsten Schramm

Hi I wrote an interface and a class which implements this interface.

I documented the interface methods of the interface.


In a third class I tried the following
IInterface myIntf = new CClass(); //CClass implements IIinterface
Click to expand...

if I now press
myIntf.DoSomething
Click to expand...

I expected a tooltiptext whith the <summary> of the interface method.
Unfortunately it shows nothing but the name, parameters and return
value.

Why?
 
PS: This effect occurs, if the interface is in another assembly then
the interface implementing class
 
Karsten,

If the interface is in another assembly, then did you generate the XML
documentation for that assmbly? You need to have the /doc switch (for
command line builds) set, or the setting in the project properties set to
generate the XML documentation (look at the project properties). Once you
built it, you need to name the file the same name as the assembly, but with
an XML extension.

If you have done all of this, you then make sure that this file is in
the same directory as the assembly is (which you have a reference to), and
then you should see the documentation.

Hope this helps.
 
Yeah thanks, it works. But only if the reference is on "local copy =
true". Is that correct?
 
Karsten,

Either way, the XML documentation file has to be in the directory that
the assembly is in that the reference is set to. Setting local copy = true
means that the assembly is copied to the output directory when it is
compiled, and shouldn't affect the search for the XML documentation file.
 
Nicholas said:
Karsten,

Either way, the XML documentation file has to be in the directory that
the assembly is in that the reference is set to. Setting local copy = true
means that the assembly is copied to the output directory when it is
compiled, and shouldn't affect the search for the XML documentation file.
Click to expand...

Yeah, but it does. I tried it in a mini project.

Please download and build

http://doena-soft.de/upload/TestXMLDoku_LocalCopy_False.rar

http://doena-soft.de/upload/TestXMLDoku_LocalCopy_True.rar

After build I cannot see the documention if localcopy = false
 

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

Similar Threads

Interface that's not an interface? 2
Why does C# not support explicit abstract interface implementations? 1
about interface 4
cast object to interface 15
Delegates VS interfaces - some confusion 10
System.Collections.Generic.IList<MicroLite.SerialNumber>' is lessaccessible than method 1
implement interface 4
About the IList interface and method GetEnumerator() 2

Back
Top