Search code examples
c#summary

c# visual studio Summarry

/// <summary>
/// Some Code PLS
/// </summary>
/// <param name="HKEY">0CurrentUser, 1LocalMachine, 2ClassesRoot, 3Users, 4CurrentConfig</param>
/// <param name="keypath">dqw</param>
/// <param name="keyname">dqwq</param>
/// <param name="keyvalue">dw1q</param>
/// <returns></returns>
public static void Create(int HKEY, string keypath, string keyname, int keyvalue)

This is my .dll code. I use in other project with "using MFG.dll". I cant see summary other project. It's only shown in dll project.

This is in project:

Screenshot Function description

Solution

  • I cant see summary other project

    The visual reason for this is because your <summary> tags are empty, they will not show a summary.

    /// <summary>
/// IM EMPTY!!!
/// </summary>
/// <param name="HKEY">0CurrentUser, 1LocalMachine, 2ClassesRoot, 3Users, 4CurrentConfig</param>
/// <param name="keypath"></param>
/// <param name="keyname"></param>
/// <param name="keyvalue"></param>
/// <returns></returns>

    To fix this you need to include a summary (text) of the routine; you also need to include the summary of your arguments. For example:

    /// <summary>
/// My routine!
/// </summary>
/// <param name="HKEY">My HKEY</param>
/// <param name="keypath">The keypath</param>
/// <param name="keyname">The actual keyname</param>
/// <param name="keyvalue">The value of the key</param>
public static void Create(int HKEY, string keypath, string keyname, int keyvalue)

    Another thing worth checking is that you have an XML Documentation file. If it's missing, there's no way to map them.

    -> Right-click on the project and select Properties. In the properties dialog, select the Build tab, and check XML documentation file.

    For more information, please visit here on related documents.