CodeClass2.Comment-Eigenschaft

Artikel
08/10/2011

Legt den der Codeklasse zugeordneten Kommentar fest oder ruft diesen ab.

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

Syntax

'Declaration
Property Comment As String
    Get
    Set

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 den Kommentar darstellt.

Implementiert

CodeClass.Comment

Hinweise

Comment legt den Headerkommentar für die Klasse fest bzw. gibt diesen zurück. Zurückgegebener 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 Comment, 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.

Tipp

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

[C#]

public void CodeClass2CommentExample(DTE2 dte2)
{
    // Before running this example, open a code document from a project
    // and place the insertion point within a class definition.
    try
    {   // Get the CodeClass2 at the insertion point.
        TextSelection sel = 
        (TextSelection)dte2.ActiveDocument.Selection;
        CodeClass2 cls = (CodeClass2)sel.ActivePoint.get_CodeElement(
            vsCMElement.vsCMElementClass);

        // Set the header comment for the CodeClass.
        cls.Comment = "Comment added programmatically.";
    }
    catch (Exception e)
    {
        Console.WriteLine(e.Message);
    }
}

.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.