Когда я пишу функции для своего проекта, а точнее, их XML комментарии к документации, я часто повторяю комментарии для определенного параметра c. Иногда это приводит к вводящей в заблуждение документации (как это обычно бывает при копировании и вставке ...).
Это простой пример, о котором я подумал, который представляет реальную проблему.
/// <summary>
/// The number that should be doubled
/// </summary>
private static float myNumber = 10f;
/// <summary>
/// Multiplies a number by 2
/// </summary>
/// <param name="number"><inheritdoc cref="myNumber"/></param>
/// <returns>The number multiplied by 2</returns>
private static float MultiplyByTwo(float number)
{
return number * 2f;
}
В этой строке /// <param name="number"><inheritdoc cref="myNumber"/></param>, хотелось бы, чтобы текст «Число, которое нужно удвоить», но он не отображается. Возможно, я не совсем понимаю использование inheritdo c.
Под появлением я подразумеваю следующее. Visual Studio должна показать документацию number в этом поле:
This is what it should look like (without copy pasting the text):
информационное окно визуальной студии, показывающее документацию при наведении курсора на функцию
Итак, есть ли способ сослаться на другую переменную в XML комментариях документации?