CodeEvent.Comment-Eigenschaft

Artikel
10/24/2012

Ruft einen dem Codeereigniselement zugeordneten Headerkommentar ab oder legt diesen fest.

Namespace: EnvDTE80
Assembly: EnvDTE80 (in EnvDTE80.dll)

Syntax

'Declaration
Property Comment As String

string Comment { get; set; }

property String^ Comment {
    String^ get ();
    void set (String^ value);
}

abstract Comment : string with get, set

function get Comment () : String
function set Comment (value : String)

Eigenschaftswert

Typ: System.String
Eine Zeichenfolge, die einen Headerkommentar enthält. Wenn kein Kommentar vorhanden ist, ist die Zeichenfolge leer.

Hinweise

Abgerufener Text enthält keine Kommentarsyntax.Der Text wird auf Grundlage vom Kommentarformat der Sprache von der Quelle abgeleitet.In C# ist das Kommentartrennzeichen zum Beispiel //, aber in Visual Basic ist es ein Apostroph (') oder Rem (Kurzform für remark).

Wenn festgelegt, versucht die Comment-Eigenschaft, das Format der vorhandenen Kommentare beizubehalten und verwendet statt einer Syntax mit Trennzeichen eine zeilenorientierte Syntax.Alle Einzüge vor zeilenorientierter Syntax werden im Prozess beibehalten, indem bestimmt wird, ob der Kommentar direkt an das Codeelement anschließt oder durch eine Leerzeile abgetrennt ist.

Hinweis
Die Werte von Codemodellelementen wie Klassen, Strukturen, Funktionen, Attributen, Delegaten usw. können nach bestimmten Bearbeitungsvorgängen nicht deterministisch sein, d. h., dass nicht mehr davon ausgegangen werden kann, dass ihre Werte immer unverändert bleiben.Weitere Informationen finden Sie im Abschnitt zum Änderungsverhalten von Codemodellelementwerten unter Ermitteln von Code über das Codemodell (Visual Basic).

Die Werte von Codemodellelementen wie Klassen, Strukturen, Funktionen, Attributen, Delegaten usw. können nach bestimmten Bearbeitungsvorgängen nicht deterministisch sein, d. h., dass nicht mehr davon ausgegangen werden kann, dass ihre Werte immer unverändert bleiben.Weitere Informationen finden Sie im Abschnitt zum Änderungsverhalten von Codemodellelementwerten unter Ermitteln von Code über das Codemodell (Visual Basic).

Beispiele

Im folgenden Beispiel wird veranschaulicht, wie die Comment-Eigenschaft verwendet wird.

So testen Sie diese Eigenschaft

Öffnen Sie das Zielprojekt, und wählen Sie das Codeereigniselement aus, indem Sie den Cursor auf das Ereignisobjekt setzen.
Führen Sie das Add-In aus.

public static void Comment(EnvDTE80.DTE2 dte)
{
    TextSelection objTextSel;
    EnvDTE80.CodeEvent codeEvent;
    objTextSel = (TextSelection)dte.ActiveDocument.Selection;
    codeEvent = (EnvDTE80.CodeEvent)objTextSel.ActivePoint.get_CodeElement(vsCMElement.vsCMElementEvent);

    MessageBox.Show("\nComment property: " +
                    codeEvent.Comment, "Testing CodeEvent");
}

.NET Framework-Sicherheit

Volle Vertrauenswürdigkeit für den unmittelbaren Aufrufer. Dieser Member kann von nur teilweise vertrauenswürdigem Code nicht verwendet werden. Weitere Informationen finden Sie unter Verwenden von Bibliotheken aus teilweise vertrauenswürdigem Code.