Подтвердить что ты не робот

Ссылка на сайт документации XML С#

Можно ли включить ссылку на сайт в документацию XML? Например, мой метод суммируется как

///<Summary>
/// This is a math function I found HERE.
///</Summary>
public void SomeMathThing(Double[] doubleArray)
{
   ...
}

и когда я печатаю

SomeMathThing(

Я хочу, чтобы IntelliSense показывала сводку с возможностью щелчка на "ЗДЕСЬ" для ссылки на внешний веб-сайт. Это возможно? Как это сделать?

Ответ 1

Try:

///<Summary>
/// This is a math function I found <see href="http://stackoverflow.com">HERE</see>
///</Summary>

Ответ 2

Немного поздно в hype-train, но вот что я узнал для 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);
    }

Результаты:

подсказка:
- Показывает cref-url с!:, но скрывает "this"
- Скрывает ahref-url, но показывает текст
- Скрывает URL-адрес и текст

Обозреватель объектов:
- Показывает cref-url с!:, но скрывает "this" (не кликабельно)
- Скрывает ahref-url, но показывает текст (не доступен для кликов)
- Скрывает URL-адрес и текст (не кликабельны)
1. ReSharper (CTRL + SHIFT + F1, команда ReSharper.ReSharper_QuickDoc)
  - Скрывает cref-url с!:, но показывает "this" (не доступен для кликов)
  - Теперь интерпретирует ahref-url (версия от 2016 и новее)
  - Скрывает URL-адрес и текст (не кликабельны)

Заключение: Лучший, как указал Хайнер, будет

See <a href="link">this link</a> for more information.

Обновление Как отметил Томас Хагстрем, Resharper теперь поддерживает кликируемые URL-адреса href. Обновлен снимок экрана соответственно.

Ответ 3

Вы можете включить префикс в 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 - не будет многозначимым, поскольку это всплывающая подсказка, чтобы вы все равно не могли ее щелкнуть.

Ответ 4

Вы можете использовать стандартный синтаксис HTML:

<a href="#" onclick="location.href='http://stackoverflow.com'; return false;">here</a>

Текст будет отображаться в Visual Studio.