tagCANDY CGI VBレスキュー(花ちゃん) の Visual Basic 2010 用 掲示板(VB.NET 掲示板) [ツリー表示へ]   [Home]
一括表示(VB.NET VB2005)
タイトル独自のプロパティに概要や戻り値を表示するには?
記事No6339
投稿日: 2007/09/21(Fri) 15:30
投稿者たかし
既存のプロパティのように、オブジェクトブラウザで
概要や戻り値の説明書きが表示されるようにするには
どのようにしたらよいでしょうか?


例)
新しいプロジェクトで“クラス ライブラリ”を選択します。
Class1.vb を SampleTextBox.vb に変更。
System.Windows.Forms を参照で追加。
以下のコードを記述。

Public Class SampleTextBox
    Inherits System.Windows.Forms.TextBox

    Private _SampleProperty As Integer

    Public Sub New()
        Me.SampleProperty = 65535
    End Sub

    <System.ComponentModel.Category("動作"), System.ComponentModel.DefaultValue(65535), _
     System.ComponentModel.Description("エディット コントロールに入力できる最大バイト数を指定します。")> _
    Public Overridable Property SampleProperty() As Integer
        Get
            Return Me._SampleProperty
        End Get
        Set(ByVal value As Integer)
            Me._SampleProperty = value
        End Set
    End Property

End Class

一旦 SampleTextBox というソルーション名で保存。
ビルドすることで SampleTextBox.dll が作成される。


新しいプロジェクトで“ Windows アプリケーション”を選択します。
ツールボックスアイテム選択で SampleTextBox.dll を参照で追加。

オブジェクトブラウザで、
SampleTextBox の SampleProperty の情報を見ると
説明書きが何も表示されません。
既存のプロパティなどを見ると概要や戻り値が表示されます。

[ツリー表示へ]
タイトルRe: 独自のプロパティに概要や戻り値を表示するには?
記事No6340
投稿日: 2007/09/21(Fri) 21:36
投稿者ダンボ
IDEで、
     Private _SampleProperty As Integer
行の直前の行に'''と3つアポストロフィを打つと、
    ''' <summary>
    '''
    ''' </summary>
    ''' <value></value>
    ''' <returns></returns>
    ''' <remarks></remarks>
が出現するから、これを編集すればよい。
(dllの参照では試したことが無いので駄目だったらごめんなさい)

    ''' <summary>概要</summary>
    ''' <value>引数の説明</value>
    ''' <returns>戻り値の説明</returns>
    ''' <remarks>注記</remarks>
    Private _SampleProperty As Integer

[ツリー表示へ]
タイトルRe^2: 独自のプロパティに概要や戻り値を表示するには?
記事No6355
投稿日: 2007/09/25(Tue) 12:12
投稿者たかし
>     ''' <summary>概要</summary>
>     ''' <value>引数の説明</value>
>     ''' <returns>戻り値の説明</returns>
>     ''' <remarks>注記</remarks>
>     Private _SampleProperty As Integer

残念ながら、この方法では、同じソルーション内であれば
『オブジェクトブラウザ』や
『コーディング時のインテリジェンスのところ』に
説明書きが表示されるのですが、
それをDLLにして、別ソルーションで読み込むと
説明書きが表示されなくなってしまうのです。。。

[ツリー表示へ]
タイトルRe^3: 独自のプロパティに概要や戻り値を表示するには?
記事No6356
投稿日: 2007/09/25(Tue) 13:14
投稿者魔界の仮面弁士
> 残念ながら、この方法では、同じソルーション内であれば
SDK 上では「ソリューション」と訳されていますね。<Solution

> 説明書きが表示されなくなってしまうのです。。。
生成された SampleTextBox.xml を、SampleTextBox.dll と共に配置してみてください。
DLL だけでは表示されません。


ちなみに、標準の DLL でも同様の作りになっていて、たとえば、
mscorlib.dll アセンブリに対応する mscorlib.xml ファイルなら、
  C:\WINDOWS\Microsoft.NET\Framework\v2.0.50727\JA\
の日本語フォルダ内に用意されていたりします。

[ツリー表示へ]