A method's description doesn't show up in another class

1.5k views Asked by At

I'm trying to add a description to my method, but it only shows up inside the original static class.

Example:

/// <summary>
/// Returns A + B
/// </summary>
/// <param name="A"></param>  
/// <param name="B"></param>
/// <returns></returns>

public static int Add(int A, int B)
{
     return A + B;
}

Before this is marked as a "duplicate", I want to make everything clear: I'm not asking how to add a description. I'm having an issue that no similar answer has solved yet.

Problem:

The description only shows up when its method is called inside their original static class library.
I added a reference to the resulting DLL in my main program and when I hover my mouse over the Add() method, no description shows up, like I had never written one in the first place. Yet, the default VS 2013 functions still have their descriptions in them even when they came from a DLL.

Am I missing something? Is it a bug?

P.S. Yes, the DLL was created after the description was already added. As far as I know, it should show up...

1

There are 1 answers

3
Kilst On BEST ANSWER

I recently just went through adding descriptions to DLL's for use in other programs, and I'm pretty sure if you're using the DLL in another solution you need to have the accompanying XML file in the same folder(as the DLL) to get the descriptions working.