C# と VB.NET の質問掲示板

ASP.NET、C++/CLI、Java 何でもどうぞ

C# と VB.NET の入門サイト

Re[7]: SubやFunctionで使用方法を表示する方法

(過去ログ 161 を表示中)

[トピック内 9 記事 (1 - 9 表示)]　 << 0 >>

■92951 / inTopicNo.1)

　SubやFunctionで使用方法を表示する方法

▼■

□投稿者/ panana (1回)-(2019/11/11(Mon) 18:31:35)

分類:[.NET 全般]　

VBを使っています。

規定のFunctionやSubの上にカーソルを合わせると
使用方法に関するコメントが表示されます。

例えば、
Directory.CreateDirectory
だと
Creates all directories and subdirectories as specified by path.
と表示されます。

これを自作したFunctionやSubでも表示できるように設定したいのですが
どのようにしたら良いですか？

引用返信 編集キー/

■92953 / inTopicNo.2)

　Re[1]: SubやFunctionで使用方法を表示する方法

▲▼■

□投稿者/ 魔界の仮面弁士 (2472回)-(2019/11/11(Mon) 18:57:13)

■No92951 (panana さん) に返信
> これを自作したFunctionやSubでも表示できるように設定したいのですが
> どのようにしたら良いですか？

たとえば
　Function Divide(a As Double, b As Double) As Double
なメソッドに説明文を作りたい場合、その直前の行に
「'''」と記述してみてください。

自動的に、以下のようなフォーマットが挿入されますので、
そこに説明文を追記すれば OK です。

''' <summary>
'''
''' </summary>
''' <param name="a"></param>
''' <param name="b"></param>
''' <returns></returns>

引用返信 編集キー/

■92955 / inTopicNo.3)

　Re[2]: SubやFunctionで使用方法を表示する方法

▲▼■

□投稿者/ panana (2回)-(2019/11/11(Mon) 20:34:39)

ありがとうございます。

うまくいきました。

ちなみにこれって、
一度デバッグ・ビルドしないと設定した内容を反映することはできませんか？

あと、

''' <summary>
'''
''' </summary>

にコメントを入力するのは分かりますが、

''' <param name="a"></param>
''' <param name="b"></param>
''' <returns></returns>

は何に使いますか？
文字を入力しても特に何も起こらないし
削除しても特に変化無しなのですが。

引用返信 編集キー/

■92956 / inTopicNo.4)

　Re[3]: SubやFunctionで使用方法を表示する方法

▲▼■

□投稿者/ panana (3回)-(2019/11/11(Mon) 20:39:16)

http://totaltech365.hatenablog.com/entry/xml-comment

このページによると
''' <summary>
''' Functionプロシージャの説明
''' </summary>
''' <param name="index">引数の説明</param>
''' <returns>返り値の説明</returns>

とすると書かれてあるのですが

私の環境では
''' <param name="index">引数の説明</param>
''' <returns>返り値の説明</returns>

が反映されません
なぜでしょうか？

引用返信 編集キー/

■92957 / inTopicNo.5)

　Re[3]: SubやFunctionで使用方法を表示する方法

▲▼■

□投稿者/ 魔界の仮面弁士 (2473回)-(2019/11/11(Mon) 20:48:48)

■No92955 (panana さん) に返信
> 一度デバッグ・ビルドしないと設定した内容を反映することはできませんか？

ビルドすると、.exe と同じフォルダに .xml ファイルが配置されますので、
それが参照されるようになっていると思います。(C# だともう少し融通が利くのですが)

.NET Framework 本体の XML はこのあたり。
C:\Program Files (x86)\Reference Assemblies\Microsoft\Framework\.NETFramework\

> ''' <param name="a"></param>
> ''' <param name="b"></param>
> ''' <returns></returns>
> は何に使いますか？
> 文字を入力しても特に何も起こらないし
> 削除しても特に変化無しなのですが。

メソッドの引数の入力を行おうとした場合に、
param の入力ヒントが表示されます。

また、オブジェクトブラウザ (Ctrl+Alt+J) にも表示されます。

https://docs.microsoft.com/ja-jp/dotnet/visual-basic/language-reference/xmldoc/

引用返信 編集キー/

■92958 / inTopicNo.6)

　Re[4]: SubやFunctionで使用方法を表示する方法

▲▼■

□投稿者/ 魔界の仮面弁士 (2474回)-(2019/11/11(Mon) 20:52:10)

2019/11/11(Mon) 21:00:02 編集(投稿者)

■No92956 (panana さん) に返信
> 私の環境では

どのバージョンの Visual Basic を利用していますか?

> 私の環境では
> ''' <param name="index">引数の説明</param>
> ''' <returns>返り値の説明</returns>
> が反映されません

ビルド後の .xml ファイルに、その内容が反映されているか確認してみてください。
反映されていないならリビルドを。

そもそも xml ファイルが生成されていない場合は、プロジェクトのプロパティを開き、
[コンパイル]タブの [XML ドキュメントファイルを生成する] にチェックが付与されているか確認してみてください。

また、今回は不要かもしれませんが、この XML からヘルプファイルを作成することも出来ます。

作成用のツールとしては、 Sandcastle Help File Builder (SHFB) がお奨め。
http://estensworks.com/devlog/2018/04/02/sandcastle-%E3%82%92-visual-studio-2017-%E3%81%A7%E4%BD%BF%E3%81%A3%E3%81%A6%E3%83%98%E3%83%AB%E3%83%97%E3%83%95%E3%82%A1%E3%82%A4%E3%83%AB%E4%BD%9C%E3%81%A3%E3%81%A6%E3%81%BF%E3%81%9F/

単一 exe なアプリを作るような場合には不要かと思いますが、
他のプロジェクトから参照設定可能な DLL を作成するような場合においては、
DLL (と XML) に加えて、ヘルプファイルも提供することができるようになります。

引用返信 編集キー/

■92959 / inTopicNo.7)

　Re[5]: SubやFunctionで使用方法を表示する方法

▲▼■

□投稿者/ panana (4回)-(2019/11/11(Mon) 21:05:36)

VS2015を使用しています。

[コンパイル]タブの [XML ドキュメントファイルを生成する] にチェックを入れた上で
XMLを確認しましたが、
> ''' <param name="a"></param>
> ''' <param name="b"></param>
> ''' <returns></returns>
が入力されていることを確認できました。

引数の入力を行いながら、
入力ヒントを確認しましたが、
やはり上記で設定した内容は表示されないのですが・・・

引用返信 編集キー/

■92960 / inTopicNo.8)

　Re[6]: SubやFunctionで使用方法を表示する方法

▲▼■

□投稿者/ panana (5回)-(2019/11/11(Mon) 21:07:12)

あと、
[コンパイル]タブの [XML ドキュメントファイルを生成する] にチェックが入っておらず、
XMLファイルが生成されなかったとしても、

''' <summary>
''' Functionプロシージャの説明
''' </summary>

のコメントは表示されるのですが、
この情報はVBファイルから直接読み込まれているのでしょうか？

引用返信 編集キー/

■92961 / inTopicNo.9)

　Re[7]: SubやFunctionで使用方法を表示する方法

▲▼■

□投稿者/ 魔界の仮面弁士 (2475回)-(2019/11/11(Mon) 21:40:27)

2019/11/11(Mon) 21:42:39 編集(投稿者)

■No92953 (魔界の仮面弁士) に補足
> 自動的に、以下のようなフォーマットが挿入されますので、

ちなみに VB2005 世代だと
''' <remarks></remarks>
も一緒に挿入されます。

■No92959 (panana さん) に返信
> VS2015を使用しています。
> 入力ヒントを確認しましたが、
> やはり上記で設定した内容は表示されないのですが・・・

[ツール]-[オプション]の
[テキストエディター]-[Basic]-[全般]の
"パラメーターヒント" は有効化されていますか?

オブジェクトブラウザ側に表示されているかどうかも確認してみてください。

古いバージョンの VB だと、別プロジェクトの XML しか読み込めないといった制限がありましたが、
VB2015 なら同一プロジェクト内でも読み込まれたはず…。

今手元に VB2015 が無いのですが、少なくとも
VB2005、2017、2019 において、パラメーターヒントが
表示されることは確認済みです。

■No92960 (panana さん) に返信
> この情報はVBファイルから直接読み込まれているのでしょうか？

解析が遅れることもありますが、可能な限り読もうとするはずです。
(Rosyln 化された VS2015 以降は、以前より遅れがちかも)

引用返信 編集キー/

トピック内ページ移動 / << 0 >>

このトピックに書きこむ

過去ログには書き込み不可

- Child Tree -