Можно ли использовать <&> для примера с обобщениями в комментариях к документу C #?

Question

Можно ли использовать <&> для примера с обобщениями в комментариях к документу C #?

1

Любой, кто когда-либо пытался написать пример для некоторого общего кода внутри комментария документации, знает, что это может быть довольно сложно, если вы не хотите, чтобы их путали с тегами. Есть ли способ сделать это?

kbzombie 10 окт. 2014, в 07:58

Источник

0

Некоторые документы MSDN используют круглые скобки (например, List(T) ). Просто предположение, но, может быть, так все и сделано?
Platinum Azure 10 окт. 2014, в 05:44
1

@PlatinumAzure In vs2013 & gt; и & lt; работать нормально
Diligent Key Presser 10 окт. 2014, в 05:52

Теги:

c#

comments

documentation

2 ответа

4

Вы должны иметь возможность использовать < и > , поскольку комментарии С# doc являются XML.

Troy Gizzi 10 окт. 2014, в 04:08

0

Да, я только что подтвердил, что это работает как ожидалось.
Troy Gizzi 10 окт. 2014, в 05:50

Ещё вопросы

Некоторые документы MSDN используют круглые скобки (например, List(T) ). Просто предположение, но, может быть, так все и сделано?
@PlatinumAzure In vs2013 & gt; и & lt; работать нормально
Да, я только что подтвердил, что это работает как ожидалось.

Peter Macej · Accepted Answer · 2014-10-10T04-35-00.000Z

Или вы можете использовать CDATA, если у вас есть более крупный пример с несколькими линиями, и вы не хотите бежать каждый <> & и ". Комментарий будет более читабельным, например:

/// <code><![CDATA[
///    List<int> mylist;
/// ]]></code>

Намного больше читаемых многострочных комментариев, приятно! Знаете ли вы, есть ли способ получить комментарии CDATA <summary> и <param> для отображения через IntelliSense?