如果将摘要添加为参考，则摘要不会显示在程序集中

Question

I've created a 'Class Library' in C#, which has many functions with summary (XML documentation comments).

For example

///<summary>
///Adds the two numbres
///</summary>
public void Add()
{
    //statements
}

if i use the function in the same namespace, its showing the summary, but if i added it as reference in some ohter workspace(solution) its not showing the summary.

How to make it visible i other solutions if a added it as a reference, and wat may be the reason for this?

Answer 1

1. Go to the solution explorer of your source code. Right click on the project name and go the properties .
2. go to the Build tab if you are using c# and select the check box Xml documentation file .
3. When you build your source code the Xml file will be generated in the location where your dll is present.
4. while copy your dll to the solution copy the xml file and paste into the bin of your destination solution.

Answer 2

You need to generate XML documentation for the assembly (a file named myassembly.xml) and copy it alongside your .dll where it's referenced by your other projects. See this page in MSDN for instructions.

Answer 3

1. Go to the solution explorer of your source code. Right click on the project name and go the properties .
2. Go to the Build tab if you are using c# and select the check box documentation file .
3. XML file will be generated within your DLL. 3-1. You can define optional path for your generated XML.
4. Copy XML file with your DLL into folder that you are using DLL.

First and second step copied from @PushParaj's answer. Thanks.

Answer 4

When you compile classes that have xml comment, normally a .xml file is created. (check the options in Visual Studio)

When you add a reference to such an assembly, make sure the XML file is present. The documentation is not contained within the assembly but within the xml file.