Можно ли включить ссылку на веб-сайт в XML-документацию? Например, мой метод резюмирован как
///<Summary>
/// This is a math function I found HERE.
///</Summary>
public void SomeMathThing(Double[] doubleArray)
{
...
}
и когда я печатаю
SomeMathThing(
Я хочу, чтобы IntelliSense отображал сводку с возможностью щелкнуть «ЗДЕСЬ», чтобы перейти на внешний веб-сайт. Это возможно? Как бы это сделать?
Ответы:
Пытаться:
///<Summary> /// This is a math function I found <see href="http://stackoverflow.com">HERE</see> ///</Summary>
источник
Немного поздно в шумихе, но вот что я узнал о Visual Studio 2015.
Мой образец выглядит так:
/// <summary> /// Retrieves information about the specified window. /// The function also retrieves the value at a specified offset into the extra window memory. /// From <see cref="!:https://msdn.microsoft.com/en-us/library/windows/desktop/ms633585(v=vs.85).aspx">this</see> MSDN-Link. /// AHref <a href="http://stackoverflow.com">here</a>. /// see-href <see href="http://stackoverflow.com">here</see>. /// </summary> /// <param name="hwnd"></param> /// <param name="index"></param> /// <returns> /// Testlink in return: <a href="http://stackoverflow.com">here</a> /// </returns> public static IntPtr GetWindowLongPtr(IntPtr hwnd, int index) { return IntPtr.Size == 4 ? GetWindowLongPtr32(hwnd, index) : GetWindowLongPtr64(hwnd, index); }
Результаты следующие:
Вывод: лучший вариант, как указал Хайнер, был бы
See <a href="link">this link</a> for more information.
Обновление Как отметил Томас Хагстрем, Resharper теперь поддерживает интерактивные URL-адреса a-href. Обновил скриншот соответственно.
источник
Вы можете использовать стандартный синтаксис HTML:
<a href="http://stackoverflow.com">here</a>
Текст будет отображаться в Visual Studio.
источник
Вы можете включить префикс !: В файл cref, чтобы он оставался нетронутым в сгенерированной документации Xml, чтобы такие инструменты, как Innovasys Document! X и Sandcastle будут использовать это. например
/// <summary> /// This is a math function I found <see cref="!:http://stackoverflow.com">HERE</see> /// </summary>
Visual Studio intellisense не будет отображать это как ссылку для intellisense - не имеет большого смысла, поскольку это всплывающая подсказка, поэтому вы все равно не можете щелкнуть по ней.
источник
<see/>
каким-то образом сделал интерактивными и распознавал URI веб-сайтов (поскольку обозреватель объектов не является всплывающей подсказкой). Просто говорю' ;-).Используйте
<a>
тег. Например, я использовал это решение в своем проекте:Результат:
Мой XML-код:
/// <summary> /// This is C# XML Documentation Website Link /// <a href="/programming/6960426/c-sharp-xml-documentation-website-link">See more</a> /// </summary>
Или используйте
<see>
тег. Результат такой же, как у<a>
тега./// <summary> /// This is C# XML Documentation Website Link /// <see href="/programming/6960426/c-sharp-xml-documentation-website-link">See more</see> /// </summary>
источник
Я тоже
<see href="https://some.com/>
сначала попробовал, и это не сработало; Однако, я потом попробовал<seealso href="https://some.url/">
и сделал работу.источник