Як уникнути символів у коментарях c #?

Сьогодні я зрозумів, що не знаю, як уникнути символів у коментарях для C #. Я хочу документувати загальний клас C #, але не можу написати належного прикладу, оскільки не знаю, як уникнути символів <та >символів. Чи потрібно використовувати <і >? Мені не подобається, якщо це так, оскільки я хочу спростити читання коментаря у фактичному документі, тому мені не потрібно генерувати якийсь документ з кодом, щоб можна було прочитати приклад коду.

Якщо вам потрібно уникнути символів у коментарях XML, вам потрібно використовувати символьні об'єкти, так <що вам потрібно буде уникати так <, як у вашому запитанні.

Альтернативою втечі є використання CDATAрозділів, з тим же ефектом.

Як ви зазначали, це може створити гарну документацію, але прочитати жахливий коментар ...

У звичайних коментарях C # ви можете використовувати будь-який символ (за винятком випадків, */коли ви починали коментар /*, або символ нового рядка, якщо ви починали з коментаря //). Якщо ви використовуєте коментарі XML, тоді ви можете використовувати розділ CDATA, щоб включити символи '<' та '>'.

Дивіться цю статтю в блозі MSDN для отримання додаткової інформації про коментарі XML на C #.

Наприклад

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

Ви сказали: "Я хочу спростити читання коментаря у фактичному документі". Я згоден.

Розробники проводять більшу частину свого життя в коді , не переглядаючи автоматично створені документи. Вони чудово підходять для бібліотек третьої сторони, як графік, але не для внутрішньої розробки, де ми працюємо з усім кодом. Я в шоці, що MSFT не придумав рішення, яке краще підтримує розробників. У нас є регіони, які динамічно розширюють / згортають код ... чому ми не можемо мати перемикання на місці виведення коментарів (між необробленим текстом та обробленим XML-коментарем або між необробленим текстом та обробленим HTML-коментарем) ?. Здається, я повинен мати деякі елементарні можливості HTML у моїх коментарях до методу / класу прологі (червоний текст, курсив тощо). Безумовно, IDE може працювати трохи HTML-магії обробки, щоб оживити вбудовані коментарі.

Моє рішення щодо хакерського рішення : я змінюю "<" на "{" і ">" на "}". Це, здається, охоплює мене для типового коментаря щодо стилю використання, включаючи ваш конкретний приклад. Недосконалий, але прагматичний враховуючи проблему читабельності (та проблеми із забарвленням коментарів IDE, що виникають при використанні '<')

C # XML коментарі записуються у XML, тому ви б використовували звичайний пропуск XML.

Наприклад...

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

Я знайшов приємне рішення цієї проблеми, просто включивши два приклади: одну важко читаючу версію у коментарях XML без символів та іншу читану версію з використанням звичайних //коментарів.

Простий, але ефективний.

Краще, ніж використовувати {...} - використовувати ≤ ... ≥ (знак менше або рівний, більше або дорівнює знаку, U2264 та U2265 в Unicode). Схоже, підкреслені кутові дужки, але все одно безумовно кутові дужки! І лише додає пару байтів у ваш файл коду.

Ще краще спробуйте U2280 та U2281 - просто скопіюйте та вставте зі списку символів Unicode (розділ математичних операторів).