CodeClass.Comment Özellik

Başvuru

Tanım

Ad Alanı:: EnvDTE

Bütünleştirilmiş Kod:: EnvDTE.dll

Bütünleştirilmiş Kod:

Önemli

Bazı bilgiler ürünün ön sürümüyle ilgilidir ve sürüm öncesinde önemli değişiklikler yapılmış olabilir. Burada verilen bilgilerle ilgili olarak Microsoft açık veya zımni hiçbir garanti vermez.

Nesneyle ilişkili yorumu alır veya ayarlar CodeClass .

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

Nesneyle ilişkili açıklamaları temsil eden bir dize CodeClass .

Öznitelikler: DispIdAttribute TypeLibFuncAttribute

Örnekler

Public Sub CodeClassExample(ByVal dte As DTE2)   
    ' Before running this example, open a code document from a  
    ' project and place the insertion point inside a class definition.  
    Try  
        Dim objTextSel As TextSelection  
        Dim objCodeCls As CodeClass  
        objTextSel = CType(dte.ActiveDocument.Selection, TextSelection)  
        objCodeCls = CType(objTextSel.ActivePoint.CodeElement(vsCMElement.vsCMElementClass), CodeClass)  
        ' Add comments to CodeClass objCodeClass - notice change in code document.  
        objCodeCls.Comment = "Comments for the CodeClass object."  
        ' Access top-level object through the CodeClass object  
        ' and return the file name of that top-level object.  
        MessageBox.Show("Top-level object's filename: " + objCodeCls.DTE.FileName)  
        ' Get the language used to code the CodeClass object - returns a GUID.  
        MessageBox.Show(objCodeCls.Language)  
        ' Get a collection of elements contained by the CodeClass object.  
        Dim members As String = "Member Elements of " + objCodeCls.Name + ": " + vbCrLf  
        Dim elem As CodeElement  
        For Each elem In  objCodeCls.Members  
            members = members + (elem.Name + vbCrLf)  
        Next elem  
        MessageBox.Show(members)  
    Catch ex As Exception  
        MessageBox.Show(ex.Message)  
    End Try  
End Sub

public void CodeClassExample(DTE2 dte)  
{  
   // Before running this example, open a code document from a  
   // project and place the insertion point inside a class definition.  
   try  
   {  
      TextSelection objTextSel;  
      CodeClass objCodeCls;  
      objTextSel = (TextSelection)dte.ActiveDocument.Selection;  
      objCodeCls = (CodeClass)objTextSel.ActivePoint.get_CodeElement(vsCMElement.vsCMElementClass);  
      // Add comments to CodeClass objCodeClass - notice change in code document.  
      objCodeCls.Comment = "Comments for the CodeClass object.";  
      // Access top-level object through the CodeClass object  
      // and return the filename of that top-level object.  
      MessageBox.Show("Top-level object's filename: " + objCodeCls.DTE.FileName);  
      // Get the language used to code the CodeClass object - returns a GUID.  
      MessageBox.Show(objCodeCls.Language);  
      // Get a collection of elements contained by the CodeClass object.  
      string members = "Member Elements of " + objCodeCls.Name + ": \n";  
      foreach (CodeElement elem in objCodeCls.Members)  
      {  
         members = members + (elem.Name + "\n");  
      }  
      MessageBox.Show(members);  
   }  
   catch (Exception ex)  
   {  
      MessageBox.Show(ex.Message);  
   }  
}

Açıklamalar

Comment üst bilgi açıklamasını ayarlar veya döndürür. Döndürüldüğünde, metin herhangi bir açıklama sözdizimi içermez.

Açıklama metni, kod öğesini içeren kaynak belgeden türetilir. Toplanan Başlık açıklaması çizgilerinin sayısı, yorumların yazıldığı dile bağlı olarak değişir.

Ayarlandığında, satır yönelimli Comment sözdiziminden önce, açıklama kod öğesine dokunmadan veya boş bir satırla ayırarak, vb. gibi, herhangi bir mevcut açıklamanın stilini tutmaya çalışır.

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