Каков наиболее практичный способ добавить комментарии к параметру метода с существующей переменной - PullRequest
0 голосов
/ 19 июня 2020

Это длинный заголовок, но здесь я объясню его немного шире

Итак, у меня есть файл с переменной, которая имеет xml комментарий

/// <summary>
/// A foo string in the file.
/// </summary>
Public string Foo;

И в конструкторе я добавляю параметр

Public Main(string foo)
{
 this.Foo = foo;
}

Теперь я хочу добавить xml комментариев к конструктору, где параметр foo содержит комментарий переменной foo.

/// <summary>
/// The constructor of this file.
/// </summary>
/// <param name="foo"> 
* The content comment of the foo variable in this file *
</param>
Public Main(string foo)
{
 this.Foo = foo;
}

Я уже пробовал:

/// <summary>
/// The constructor of this file.
/// </summary>
/// <param name="foo"><see="Foo"></param>
Public Main(string foo)
{
 this.Foo = foo;
}

Или:

/// <summary>
/// The constructor of this file.
/// </summary>
/// <param name="foo"><seealso="Foo"></param>
Public Main(string foo)
{
 this.Foo = foo;
}

И даже:

    /// <summary>
/// The constructor of this file.
/// </summary>
/// <param name="foo"><inheritdoc cref="Foo"/></param>
Public Main(string foo)
{
 this.Foo = foo;
}

У кого-то еще возникла такая же проблема и как могу ли я решить эту проблему?

Это то, что я хочу получить, когда наводю указатель мыши на переменную параметра:

(поле) строка Main.Foo

Строка foo в файле.

А не:

(поле) строка Main.Foo

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...