CodeClass2.Comment Özellik

Makale
05/18/2015

Kod sınıfıyla ilişkilendirilmiş yorum alır ya da ayarlar.

Ad alanı: EnvDTE80
Derleme: EnvDTE80 (EnvDTE80.dll içinde)

Sözdizimi

'Bildirim
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)

Özellik Değeri

Tür: String
Yorum temsil eden bir dize.

Notlar

Commentayarlar veya üstbilgi yorum sınıfı döndürür.Hiçbir açıklama sözdizimi döndürülen metin içermiyor.Metin dilin açıklama stili temel alan kaynak türetilir.Örneğin, C# [NULL]'ta açıklama sınırlayıcısı'dir / /, ancak Visual Basic'te, bir kesme işareti (') veya Rem (kısaltması açıklama).

Ayarlandığında, Comment denemeleri stilini kullanarak varolan her türlü açıklamanın satır yönelimli karşı korumak için ayrılmış sözdizimi.Bu süreçte, yorum kod öğesi dokunduğundan veya boş bir satır ayırarak belirleyerek satır yönelimli sözdizimi önce herhangi bir girinti korur.

[!NOT]

Kod modeli öğe sınıfları, yapılar, İşlevler, öznitelikleri, temsilciler ve diğerleri gibi düzenlemeler değerlerine bağlı her zaman aynı kalmasına dayanıyordu olamaz, başka bir deyişle, belirli türdeki yaptıktan sonra kararlı olmayan olabilir.Daha fazla bilgi için kod modeli öğesi değerleri değiştirebilir bölümüne bakın Kod Modeli Kullanarak Kodu Keşfetme (Visual Basic).

Örnekler

[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 Güvenliği

Anında arayanlar için tam güven. Bu üye kısmen güvenilen kodla kullanılamaz. Daha fazla bilgi için bkz. Kısmen Güvenilen Koddan Kitaplıkları Kullanma.