CodeEvent.DocComment-Eigenschaft

Artikel
10/24/2012

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

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

Syntax

'Declaration
Property DocComment As String

string DocComment { get; set; }

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

abstract DocComment : string with get, set

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

Eigenschaftswert

Typ: System.String
Eine Zeichenfolge, die einen Dokumentationskommentar enthält, der dem Codeereigniselement zugeordnet ist, oder eine leere Zeichenfolge, wenn kein Kommentar bereitgestellt wird.

Hinweise

Eine leere Zeichenfolge wird zurückgegeben, wenn kein Kommentar bereitgestellt wird oder wenn die Sprache, die den Code implementiert, keinen Mechanismus für Dokumentationskommentare besitzt.

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 DocComment-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 DocComment(EnvDTE80.DTE2 dte)
{
    TextSelection objTextSel;
    EnvDTE80.CodeEvent codeEvent;
    objTextSel = (TextSelection)dte.ActiveDocument.Selection;
    codeEvent = (EnvDTE80.CodeEvent)objTextSel.ActivePoint.get_CodeElement(vsCMElement.vsCMElementEvent);

    MessageBox.Show("\nDocComment property: " +
                    codeEvent.DocComment, "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.