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

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

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

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

 SomeMathThing(

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

100 голосов | спросил john 5 PM00000090000002331 2011, 21:42:23

4 ответа


0

Try:

///<Summary>
/// This is a math function I found <see href="http://stackoverflow.com">HERE</see>
///</Summary>
ответил dizzwave 5 PM00000090000005831 2011, 21:55:58
0

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

Результаты:

  1. подсказке:

  1. ReSharper (CTRL + SHIFT + F1, команда ReSharper.ReSharper_QuickDoc)
    • Скрывает cref-url с!:, но показывает "это" (не активируется)
    • Теперь интерпретирует ahref-url (версия от 2016 года и новее)
    • Скрывает URL и текст Seehref (не кликабельно) Снимок экрана Resharper QuickHelp «> </a>
</li>
</ul>
</li>
</ol>
<p> Вывод: лучшим, как отметил Хайнер, будет </p>

<pre><code>---- +: = 1 = + ----</code></pre>

<p> <strong> Обновление </STRONG>
Как отметил Томас Хагстрём, Resharper теперь поддерживает кликабельные URL-адреса a-href. Обновлен скриншот соответственно. </p></body></html>
ответил MHolzmayr 22 ndEurope/Moscowp30Europe/Moscow09bEurope/MoscowTue, 22 Sep 2015 11:47:37 +0300 2015, 11:47:37
0

Вы можете включить префикс!: в cref, чтобы он не затрагивался в сгенерированной документации XML, чтобы такие инструменты, как Документ Innovasys! X и Sandcastle будет использовать его. например.

/// <summary>
/// This is a math function I found <see cref="!:http://stackoverflow.com">HERE</see>
/// </summary>

IntelliSense для Visual Studio не будет отображать это как ссылку для intellisense - не будет особой точки зрения, поскольку это всплывающая подсказка, поэтому вы все равно не можете щелкнуть по ней.

ответил fubaar 11 PM00000020000003531 2011, 14:08:35
0

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

<a href="http://stackoverflow.com">here</a>

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

ответил Heiner 23 J000000Tuesday13 2013, 13:13:40

Похожие вопросы

Популярные теги

security × 330linux × 316macos × 2827 × 268performance × 244command-line × 241sql-server × 235joomla-3.x × 222java × 189c++ × 186windows × 180cisco × 168bash × 158c# × 142gmail × 139arduino-uno × 139javascript × 134ssh × 133seo × 132mysql × 132