Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Summary is not showing in the assembly if it is added as a reference

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?

like image 606
Thorin Oakenshield Avatar asked Jun 25 '11 09:06

Thorin Oakenshield


People also ask

How to Add reference to assembly c#?

In the Project Designer, click the References tab. Click the Add button to open the Add Reference dialog box. In the Add Reference dialog box, select the tab indicating the type of component you want to reference. Select the components you want to reference, and then click OK.

How to Add reference of one project to another in c#?

Add a reference In Solution Explorer, right-click on the References or Dependencies node and choose either Add Project Reference, Add Shared Project Reference, or Add COM Reference. (You can right-click the project node and select Add from the fly-out menu to choose from these options, too.)


2 Answers

  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.
like image 52
Pushparaj Avatar answered Oct 12 '22 11:10

Pushparaj


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.

like image 30
Jon Avatar answered Oct 12 '22 13:10

Jon