Come faccio a eseguire l'escape dei caratteri nei commenti c #?

Mi sono reso conto oggi che non so come sfuggire ai caratteri nei commenti per C #. Voglio documentare una classe C # generica, ma non posso scrivere un esempio corretto poiché non so come eseguire l'escape dei caratteri <e >. Devo usare <e >? Non mi piace se questo è il caso poiché voglio che sia facile leggere il commento nel documento effettivo, quindi non devo generare alcun tipo di documento di codice per poter leggere il codice di esempio.

Se è necessario eseguire l'escape dei caratteri nei commenti XML, è necessario utilizzare le entità carattere, quindi è <necessario eseguire l'escape come <, come nella domanda.

L'alternativa all'escape è usare le CDATAsezioni, allo stesso effetto.

Come hai notato, questo produrrebbe una buona documentazione, ma un commento orribile da leggere ...

Nei semplici commenti C # puoi usare qualsiasi carattere (tranne */se hai iniziato il commento con /*, o il carattere di nuova riga se hai iniziato il commento con //). Se si utilizzano commenti XML, è possibile utilizzare una sezione CDATA per includere i caratteri "<" e ">".

Vedere questo articolo del blog MSDN per ulteriori informazioni sui commenti XML in C #.

Per esempio

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

Hai detto "Voglio che sia facile leggere il commento nel documento vero e proprio". Sono d'accordo.

Gli sviluppatori trascorrono la maggior parte della loro vita nel codice , senza esaminare i documenti generati automaticamente. Questi sono ottimi per le librerie di terze parti come la creazione di grafici, ma non per lo sviluppo interno in cui lavoriamo con tutto il codice. Sono un po 'scioccato dal fatto che MSFT non abbia trovato una soluzione che supporti meglio gli sviluppatori qui. Abbiamo regioni che espandono / comprimono dinamicamente il codice ... perché non possiamo avere un interruttore sul posto per il rendering dei commenti (tra testo non elaborato e commento XML elaborato o tra testo non elaborato e commento HTML elaborato) ?. Sembra che dovrei avere alcune funzionalità HTML elementari nei miei commenti sul prologo di metodo / classe (testo in rosso, corsivo, ecc.). Sicuramente un IDE potrebbe funzionare un po 'di magia di elaborazione HTML per ravvivare i commenti in linea.

La mia soluzione di hack-of-a-solution : cambio '<' in "{" e '> "in"} ". Questo sembra coprirmi per il tipico commento sullo stile di utilizzo di esempio, incluso il tuo esempio specifico. Imperfetto, ma pragmatico dato il problema di leggibilità (e problemi con la colorazione dei commenti IDE che derivano dall'uso di '<')

I commenti XML in C # sono scritti in XML, quindi useresti il ​​normale codice di escape XML.

Per esempio...

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

Ho trovato una soluzione vivibile a questo problema includendo semplicemente due esempi: una versione di difficile lettura nei commenti XML con caratteri di escape e un'altra versione leggibile utilizzando //commenti convenzionali .

Semplice ma efficace.

Meglio che usare {...} sta usando ≤ ... ≥ (segno minore o uguale, segno maggiore o uguale, U2264 e U2265 in Unicode). Sembrano parentesi angolari sottolineate ma ancora decisamente parentesi angolari! E aggiunge solo un paio di byte al file di codice.

Ancora meglio provare U2280 e U2281: basta copiare e incollare dall'elenco dei caratteri Unicode (sezione operatori matematici).