CodeClass2.Comment Özellik

  • Başvuru

Tanım

Ad Alanı:
EnvDTE80
Bütünleştirilmiş Kod:
EnvDTE80.dll
Bütünleştirilmiş Kod:

Kod sınıfıyla ilişkili yorumu ayarlar veya alır.

public:
 property System::String ^ Comment { System::String ^ get(); void set(System::String ^ value); };
public:
 property Platform::String ^ Comment { Platform::String ^ get(); void set(Platform::String ^ value); };
[System.Runtime.InteropServices.DispId(38)]
public string Comment { [System.Runtime.InteropServices.DispId(38)] [System.Runtime.InteropServices.TypeLibFunc(1024)] get; [System.Runtime.InteropServices.DispId(38)] [System.Runtime.InteropServices.TypeLibFunc(1024)] set; }
[<System.Runtime.InteropServices.DispId(38)>]
[<get: System.Runtime.InteropServices.DispId(38)>]
[<get: System.Runtime.InteropServices.TypeLibFunc(1024)>]
[<set: System.Runtime.InteropServices.DispId(38)>]
[<set: System.Runtime.InteropServices.TypeLibFunc(1024)>]
member this.Comment : string with get, set
Public Property Comment As String

Özellik Değeri

String

Yorumu temsil eden bir dize.

Uygulamalar

Comment
Öznitelikler
DispIdAttribute TypeLibFuncAttribute

Örnekler

Þ

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);  
    }  
}

Açıklamalar

Comment sınıf için üst bilgi açıklamasını ayarlar veya döndürür. Döndürülen metin herhangi bir açıklama sözdizimi içermiyor. Metin, dilin yorum stiline göre kaynaktan türetilir. Örneğin, C# ' de açıklama sınırlayıcısı//olur, ancak Visual Basic, kesme işareti (') veya REM (açıklama için kısa).

Ayarlandığında, Comment satır yönelimli ve sınırlandırılmış söz dizimi kullanarak varolan bir açıklamanın stilini tutmaya çalışır. İşleminde, açıklama kod öğesine dokunmadan veya boş bir satırla ayrılıp ayrılmadığını belirleyerek, satır odaklı sözdiziminden önce girinti saklar.

Not

Sınıfların, yapıların, işlevlerin, özniteliklerin, temsilcilerin ve bu gibi kod modeli öğelerinin değerleri, belirli tür düzenlemeler yapıldıktan sonra belirleyici olmayan bir değer olabilir, yani değerlerinin her zaman aynı kalır. Daha fazla bilgi için bkz. kod modeli öğe değerleri, kod modeli kullanılarak kod bulma bölümünde değişebilir (Visual Basic).

Şunlara uygulanır