c # visual studio Summarry

Question

/// <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)

Это мой код .dll . Я использую в другом проекте с « используя MFG.dll ». Я не могу видеть резюме другого проекта. Отображается только в проекте dll.

Это в проекте:

Answer 1

Я не вижу резюме другого проекта

Визуальная причина этого в том, что ваши теги <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>

Чтобы это исправить, вам нужно включить краткое изложение (текст) процедуры;Вы также должны включить резюме ваших аргументов. Например:

/// <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)

Еще одна вещь, которую стоит проверить, это то, что у вас есть файл XML Documentation. Если он отсутствует, его невозможно сопоставить.

-> Щелкните правой кнопкой мыши проект и выберите «Свойства». В диалоговом окне свойств выберите вкладку «Сборка» и проверьте файл документации XML.

Для получения дополнительной информации, пожалуйста, посетите здесь для связанных документов.

Answer 2

Вам необходимо поместить свои комментарии в текст тега, например:

    /// <summary>
    /// Creates something or other.  
    /// </summary>
    /// <param name="HKEY">0 = CurrentUser, 1 = LocalMachine, 2 = ClassesRoot, 3 = Users, 4 = CurrentConfig</param>
    /// <param name="keypath">The key path.</param>
    /// <param name="keyname">The key name.</param>
    /// <param name="keyvalue">The key value</param>
    public static void Create(int HKEY, string keypath, string keyname, int keyvalue)

Я удалил тег возврата, так как этот метод возвращает void (без возвращаемого значения).