次の方法で共有


CodeVariable.Comment プロパティ

コード要素に関連付けられたコメントを取得または設定します。

名前空間:  EnvDTE
アセンブリ:  EnvDTE (EnvDTE.dll 内)

構文

'宣言
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)

プロパティ値

型 : System.String
コード要素に関連付けられたコメントを表す文字列。

解説

Comment は、ヘッダー コメントを設定または取得します。返されるときには、テキストにコメント構文は含まれていません。

コメント テキストは、コード要素を含んでいるソース ドキュメントから派生します。収集されるヘッダー コメント行の数は、コメントが書かれた言語により異なります。

設定された場合、Comment は既存のコメントのスタイルを維持しようとします。これは、行指向の構文と区切り形式の構文のどちらかを使用する、行指向の構文の前のインデントを維持する、コメントがコード要素と接しているか空白行で区切られているかを決定するなどによって行います。

[!メモ]

特定の種類の編集を行った後に、クラス、構造体、関数、属性、デリゲートなどのコード モデル要素の値を決定できないことがあります。つまり、これらの要素の値は、信頼できる値ではなく、常に同じ値になるとは限りません。詳細については、「コード モデルを使用したコードの調査 (Visual Basic)」で、コード モデル要素値を変更する方法についての説明を参照してください。

.NET Framework セキュリティ

  • 直前の呼び出し元に対する完全な信頼。このメンバーは、部分的に信頼されているコードから使用することはできません。詳細については、「部分信頼コードからのライブラリの使用」を参照してください。

参照

関連項目

CodeVariable インターフェイス

EnvDTE 名前空間

その他の技術情報

方法 : オートメーション オブジェクト モデルのコード例をコンパイルおよび実行する

コード モデルを使用したコードの調査 (Visual Basic)

コード モデルを使用したコードの調査 (Visual C#)