XMLコメントタグ について

解決


まさお  2013-02-20 02:13:21  No: 148085

まさお と申します。  宜しくお願い致します。

  WinXP Pro SP3,VB2010 Express SP1 です。

  XMLコメントタグ(で、良いのだと思います)について教えてください。

  自作関数に '''<summary>, <param name=...> を付加すると、その自作関数を使用する際にツールチップのように表示されます。
  しかし、<returns>, <remarks> を付加しても表示されないのですが、これを表示させるにはどうすれば良いでしょうか?

  それとも <returns>, <remarks> は別の目的用でしょうか?
      ※XLMドキュメント用?

以上、宜しくお願い致します。


YuO  2013-02-21 01:29:11  No: 148086

基本的にはドキュメント生成用です。
同様の物に,see要素などもあります。
# VS.NET 2003の時代にはドキュメント生成機能がVSに一応あったのですが……。

Sandcastleなどのツールを使って,自分でクラスライブラリのドキュメントを生成した場合に,読み取ってくれます。
http://sandcastle.codeplex.com/


まさお  2013-02-21 02:03:11  No: 148087

YuO さん、ありがとうございました。

> VS.NET 2003の時代にはドキュメント生成機能がVSに一応あったのですが……。
  2010ではコンパイルすると自動でできるみたいです。
  少なくとも私の環境では自動で出来ています。

> Sandcastleなどのツールを使って,…
  オオー!
  XMLドキュメントを何に使うのか判らなかったのですが、やっと判りました。
  ツールチップにはならなくてもヘルプ表示できるのですネ。
  他にも利用価値はあるのでしょうけど、小さなシステムを一人で作っている分には活用しなくても、という気分です。

  ありがとうございました。
  解決しました。

  暫くしたら閉じます。


YuO  2013-02-21 03:27:29  No: 148088

>   2010ではコンパイルすると自動でできるみたいです。
>   少なくとも私の環境では自動で出来ています。

えーっと,.xmlファイルではないですよ。
人が読めるHTMLファイル群を出力できました。

http://www.atmarkit.co.jp/fdotnet/teamdev/teamdev01/teamdev01_02.html
の「FractionsクラスのRound()メソッドのAPIリファレンス」の部分のようなドキュメントです。
まぁ,当時はNDocというのがあって,そちらの方がVSの物より高機能だったため,NDocの方が使われていましたが。


まさお  2013-02-21 20:55:24  No: 148089

YuO さん、ありがとうございます。

> えーっと,.xmlファイルではないですよ。
> 人が読めるHTMLファイル群を出力できました。
  そうなのですか。  それは便利な機能ですネ。

  今、気が付いたのですが、<returns>, <remarks>はオブジェクトブラウザには反映されます。
  これだけでも個人使用ではそれなりに使えそうです。

  これにて閉じます。
  YuO さん、どうも、ありがとうございました。


※返信する前に利用規約をご確認ください。




  


  このエントリーをはてなブックマークに追加