次の方法で共有


CodeFunction.DocComment プロパティ

現在のコード モデル要素のドキュメント コメントを取得または設定します。

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

構文

'宣言
Property DocComment As String
string DocComment { get; set; }
property String^ DocComment {
    String^ get ();
    void set (String^ value);
}
abstract DocComment : string with get, set
function get DocComment () : String 
function set DocComment (value : String)

プロパティ値

型 : String
ドキュメント コメントを表す文字列。

解説

DocComment は、コード内に特殊なドキュメント コメントや属性がある場合にそれを返します。 コード モデルを実装している言語にドキュメント コメントの機構がない場合や、コード要素に関連付けられているドキュメント コメントがない場合、DocComment では空の文字列が返されます。

注意

Visual Basic のソース コードのコード要素に対しては、このプロパティは読み取り専用です。

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

.NET Framework セキュリティ

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

参照

関連項目

CodeFunction インターフェイス

EnvDTE 名前空間

その他の技術情報

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

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

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