Xml-Zeichenfolge in einem C # -Zusammenfassungskommentar

Bin ich dokumentieren ein paar Methoden, die ich geschrieben in C#, die sich mit Analyse-Token. Durch einige technische Einschränkungen in anderen Bereichen des Systems, diese Token müssen in form von XML-Elementen (D. H., <tokenName />). Ich würde gerne das format von diesen Token in die zusammenfassende Erklärung selbst.

Aber das wirft einen Fehler: nicht wohlgeformt XML -- Ein name war, begann mit einem ungültigen Zeichen". Gibt es irgendeine Art von escape-Zeichenfolge, die ich verwenden kann zum einbetten von XML-Code in meinem C# - Zusammenfassung Kommentare?

InformationsquelleAutor der Frage loomisjennifer | 2009-03-03

  1. 38

    Verwenden standard-XML-escaping. Zum Beispiel:

    <summary>This takes a &lt;token1&gt; and turns it into a &lt;token2&gt;</summary>

    Es ist nicht super-einfach zu schreiben oder zu Lesen als code, aber IntelliSense richtig unescapes und sehen dies auch die richtigen, lesbaren, was im tooltip.

    InformationsquelleAutor der Antwort Andrew Arnott

  2. 25

    Verwenden Sie einen CDATA-Abschnitt. Zum Beispiel:

    <![CDATA[ <name>Bob</name> ]]>

    Dies ist mehr elegante und lesbare Quelle, als die Codierung von Sonderzeichen in entities wenn Sie eine größere XML-Stück.

    Wenn die XML, die Sie einbetten möchten sich CDATA-Abschnitte enthält, die Sie verwenden müssen, mehrere CDATA-Abschnitte, wie beschrieben in eine weitere Antwort auf Stack Overflow oder auf Wikipedia. Oder können Sie immer dann verwenden plain-entity-Referenzen wie beschrieben in den anderen Antworten hier.

    InformationsquelleAutor der Antwort Sean

  3. 4

    Ich escape-Sequenzen, weil VisualStudios tooltip nicht angezeigt wird alles, was innerhalb eines CDATA-Abschnitt.

    InformationsquelleAutor der Antwort FloWi

  4. 2

    Es ist sehr spät, aber lief in das gleiche problem, mit <![CDATA[]]> versteckt den Kommentar in Intellisense.

    Ersetzen beide < und > war zu viel Arbeit für mich (faul 🙂 ). Ich fand heraus, dass nur die Erneuerung der < mit &lt; war genug für die Intellisense-da macht es die xml ungültig und eignet sich für die Intellisense zu analysieren, wie Texte in Ihrer Zusammenfassung block.

    Hier ist ein Beispiel:

    ///<summary>
///Parse the queue process response
///<para>&lt;?xml version="1.0" encoding="utf-16"?>&lt;result success="True">&lt;entity type="resource" operation="update" />&lt;/result></para>
///<![CDATA[
///<?xml version="1.0" encoding="utf-16"?><result success="True"><entity type="resource" operation="update" /></result>
///]]></summary>
///<param name="response"></param>
///<returns></returns>

    Intellisense zeigt dies:

    Parse the queue process response
<?xml version="1.0" encoding="utf-16"?><result success="True"><entity type="resource" operation="update" /></result>

    InformationsquelleAutor der Antwort Mario

Schreibe einen Kommentar