DOBON.NET DOBON.NETプログラミング掲示板過去ログ

メンバの一覧に自前の説明を表示させたい

環境/言語:[Windows XP/VB.NET 2003]
分類:[.NET]

VB.NETのIDEでIntelliSenseを使って、メンバの一覧を表示させると、
そのメンバの説明がツールチップで表示されますよね。

例えば、TextBox.Visible を選ぶと、
「Public Property Visible As Boolean
 コントロールが表示されているかどうかを示す値を設定または取得します」
というような感じです。

自分で作ったクラスのメンバにも、この「コントロールが表示されて・・・」のような説明文を表示させたいのですが、どうしたらよいかわかりません。

よろしくお願いします。
VB.NETでは無理っぽいですね。
C#なら簡単なのに...。
■No1523に返信(Sugi@み〜くんパパの仕事部屋さんの記事)
> VB.NETでは無理っぽいですね。
> C#なら簡単なのに...。

返信ありがとうございます。

ヘルプをソースコードと別に用意すると、仕様の追加や変更に同期させるのが大変なので、何かいい手はないかと思ってたんです。

とりあえず、他の手を考えた方が良さそうですね。
■No1532に返信(ケメさんの記事)
> 返信ありがとうございます。
>
> ヘルプをソースコードと別に用意すると、仕様の追加や変更に同期させるのが大変なので、何かいい手はないかと思ってたんです。
>
> とりあえず、他の手を考えた方が良さそうですね。
>

C#ですとXMLコメントが出力できますので、
XMLコメントとアセンブリを同じフォルダにおいておくだけでよいのですが、
VBにはXMLコメント機能はありません。

当方ではVB環境でXMLコメントを出力させるため
VBXCというツールを使用しています。
http://vbxmldoc.tor-erik.net/index.shtml

'<summary>aaaa</summary>
'<remarks>bbbb</remarks>
'<param name="c">cccc</param
Public Sub Fuga(c As Integer)

End Sub

のように、C#と同じように記述し、
XMLコメントを出力できます。
VS.NETにアドオンするツールです。
ただ、VS.NET 2003だと列挙体でうまく出力できない不具合があり、
たまにキズです。

また、
http://sourceforge.net/projects/vb-doc/
http://www.fesersoft.com/products/VBXmlComments/default.asp (有償)
等もあるようです。

どこかのNewsGroupで見た情報では、次期バージョンで
この機能が搭載されるとか。

その他情報、ツール、ご存知の方、お教えいただけると幸いです。
■No1604に返信(tkymさんの記事)

返信ありがとうございます。

> 当方ではVB環境でXMLコメントを出力させるため
> VBXCというツールを使用しています。
> http://vbxmldoc.tor-erik.net/index.shtml

ありがとうございます!
ソリューションをビルドするだけでXMLコメントも更新されるので、
非常に楽になりそうです。

> どこかのNewsGroupで見た情報では、次期バージョンで
> この機能が搭載されるとか。

搭載されたら即買いです。多分。
別にヘルプ作る工数を考えたらあっという間に元が取れそうですし。
解決済み!

DOBON.NET | プログラミング道 | プログラミング掲示板