CodeEnum.DocComment プロパティ

[アーティクル]
08/22/2008

更新 : 2007 年 11 月

CodeEnum 要素のドキュメントコメントを取得します。

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

構文

'宣言
Property DocComment As String
'使用
Dim instance As CodeEnum
Dim value As String

value = instance.DocComment

instance.DocComment = value

string DocComment { get; set; }

property String^ DocComment {
    String^ get ();
    void set (String^ value);
}

function get DocComment () : String
function set DocComment (value : String)

プロパティ値

型 : System.String

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

解説

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

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

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

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