Используя XML-комментарий C# cref приписывают с синтаксисом параметрических усилителей
3 ответа
Стандарт ECMA 334, PDF, Приложение E, содержит хороший обзор комментариев к XML-документации. Вы можете скачать стандарт по адресу:
http://www.ecma-international.org/publications/standards/Ecma-334.htm
В частности, вам понадобится раздел E.3.1, начиная со страницы 496.
Аналогичный контент также есть в MSDN (хотя MSDN, кажется, имеет ужасную навигацию по этой теме, что затрудняет поиск других разделов):
http://msdn.microsoft.com/en-us/library/ aa664787 (VS.71) .aspx
Эквивалент E.3.1:
http://msdn.microsoft.com/en-us/library/aa664807 (VS.71) .aspx
Вы можете также полезна документация Mono:
http://www.go-mono.com/docs/ index.aspx?tlink=29@man% 3amdoc (5)
В частности, раздел «ФОРМАТ CREF» охватывает условные обозначения строки идентификатора.
Обновление 2018/05/23
URL-адрес стандартного PDF-файла ECMA-334, приведенный выше, ссылается на последнее издание стандарт. В 2009 году это было 4-е издание стандарта. Однако по состоянию на декабрь 2017 года 5-е издание является действующим, и раздел E.3.1 из 4-го издания стал разделом D.4.2 в 5-м издании.
Предыдущие версии стандарта ECMA-334 доступны для загрузки с следующая страница: https://www.ecma-international.org/publications/standards/Ecma-334-arch.htm
Вы просто опускаете ключевое слово param и вводите такой тип:
/// <summary>
/// <see cref="Method(string[])"/>
/// </summary>
public static void Main()
{
Method("String1", "String2");
}
public static void Method(params string[] values)
{
foreach (string value in values)
{
Console.WriteLine(value);
}
}
Согласно статье B.3.1 Формат строки идентификатора , ссылка на массив выполняется с помощью [квадратных скобок] (с необязательными спецификаторами lowerbound: size ), но если вы просто хотите сослаться на массив определенного типа (или даже на массив объектов), вы не можете просто написать
<см. cref = "Object []" />
вместо этого вам нужно укажите, что вы создаете ссылку на тип с префиксом T: , например
<см. cref = "T: Object []" />
Это, похоже, не применяется при ссылке на конкретный перегрузка метода, например