Как мне избежать символов в комментариях c#?

сегодня я понял, что не знаю, как избежать символов в комментариях для C#. Я хочу документировать общий класс C#, но я не могу написать правильный пример, так как я не знаю, как избежать < и > символы. Я должен использовать &lt; и &gt;? Мне не нравится, если это так, так как я хочу, чтобы было легко прочитать комментарий в фактическом документе, поэтому мне не нужно создавать какой-то кодовый документ, чтобы иметь возможность читать пример кода.

7 76
c#

7 ответов:

Если вам нужно экранировать символы в комментариях XML, вам нужно использовать сущности символов, поэтому < должен быть экранирован как &lt;, как в вашем вопросе.

альтернативой побега является использование CDATA разделы, к тому же эффекту.

как вы отметили, это даст хорошую документацию, но ужасный комментарий для чтения...

106

в простых комментариях C# вы можете использовать любой символ (кроме */ Если вы начали комментария /*, или символ новой строки, Если вы начали комментария //). Если вы используете комментарии XML, то вы можете использовать раздел CDATA включить символы ' '.

посмотреть эта статья блога MSDN для получения дополнительной информации о комментариях XML в C#.

/// <summary>
/// Here is how to use the class: <![CDATA[ <test>Data</test> ]]>
/// </summary>
43

Вы сказали:"я хочу, чтобы было легко прочитать комментарий в фактическом документе". Я согласен.

разработчики проводят большую часть своей жизни код, не просматривая автоматически созданные документы. Они отлично подходят для сторонних библиотек, таких как диаграммы, но не для внутренней разработки, где мы работаем со всем кодом. Я немного шокирован тем, что MSFT не придумал решение, которое лучше поддерживает разработчиков здесь. У нас есть регионы, которые динамично развернуть/свернуть код...почему мы не можем иметь переключатель рендеринга комментариев на месте (между необработанным текстом и обработанным комментарием XML или между необработанным текстом и обработанным комментарием HTML)?. Похоже, у меня должны быть некоторые элементарные возможности HTML в моих комментариях к прологу метода/класса (красный текст, курсив и т. д.). Конечно, IDE может работать немного магии обработки HTML, чтобы оживить встроенные комментарии.

мой хак-это раствор: Я меняю ' "на"}". Это, кажется, покрывает меня для типичный пример комментария стиля использования, включая ваш конкретный пример. Несовершенный, но прагматичный, учитывая проблему читаемости (и проблемы с раскраской комментариев IDE, которые возникают при использовании '

14

комментарии XML C# написаны в XML, поэтому вы будете использовать обычный XML-экранирование.

например...

<summary>Here is an escaped &lt;token&gt;</summary>
5

Я нашел приемлемое решение этой проблемы, просто включающее два примера: одна трудночитаемая версия в комментариях XML с escape-символами и другая читаемая версия с использованием обычного // комментарии.

простой, но эффективный.

2

лучше, чем с помощью {...} использует ≤...≥ (меньше или знак равенства, больше или знак равенства, U2264 и U2265 в Юникоде). Похоже на подчеркнутые угловые скобки, но все же определенно угловые скобки! И только добавляет пару байт в файле кода.

1

еще лучше попробовать U2280 и U2281 - просто скопируйте и вставьте из список символов Unicode (раздел математические операторы).

0